Model MatchHelp

Branches

Loan officers on this branch's current roster

postapi.modelmatch.com/v1/branches/{nmlsId}/roster

The loan officers currently registered to this branch location who hold an active sponsorship or registration — one row per person, with current employer, tenure, years in the industry, manager flags and collected contact info. This is the LICENSING roster; for the loan officers whose loans public record attributes to the branch, use branchOriginators.

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Path parameters

nmlsIdstringrequired

Branch NMLS ID

Body application/json

flatFiltersobject
Show child attributes
isBranchManagerboolean | null
nameone of | null

Loan officer name. Matches ALL the words supplied, fuzzily. Scoped to this branch's roster.

Show child attributes
Option 1string
Option 2string[]

Match any value

Option 3object

Fuzzy text match

Show child attributes
matchstringrequired
tenureMonthsone of | null

Whole months at the loan officer's current company.

Show child attributes
Option 1number
Option 2number[]

Match any value

Option 3object

Numeric range. Excludes null/missing-field docs by default; add includeNulls: true to keep them.

Show child attributes
gtnumber
gtenumber
includeNullsboolean

Also keep docs where the field is null/missing (a range filter drops them by default). Requires at least one of gte/lte/gt/lt.

ltnumber
ltenumber
yearsInIndustryone of | null
Show child attributes
Option 1number
Option 2number[]

Match any value

Option 3object

Numeric range. Excludes null/missing-field docs by default; add includeNulls: true to keep them.

Show child attributes
gtnumber
gtenumber
includeNullsboolean

Also keep docs where the field is null/missing (a range filter drops them by default). Requires at least one of gte/lte/gt/lt.

ltnumber
ltenumber
paginationobject
Show child attributes
cursorstring

Opaque cursor from previous response for next page

sizeinteger

Page size (1-100, default 25)

sortobject[]
Show child attributes
fieldenumrequired
Options:nametenureMonthsyearsInIndustrystatecity
orderenum
Options:ascdesc

Responses

200objectPaginated roster
Show attributes
cursorstring
dataobject[]required
Show child attributes
citystring | null
companyNamestring | null
companyNmlsIdstring | null

Current employer (active sponsorship first, then active registration).

companyStartDatestring | null
contactobject | null
Show child attributes
cellPhonestring | null
employerAddressstring | null
employerCitystring | null
employerCompanystring | null
employerCompanyIdstring | null
employerStatestring | null
employerTypestring | null
employerWebsitestring | null
employerZipstring | null
facebookstring | null
linkedinstring | null
officePhonestring | null
officePhoneExtstring | null
personalEmailstring | null
twitterstring | null
websitestring | null
workEmailstring | null
firstNamestring | null
idstringrequired
isBranchManagerboolean | null

Manages ANY branch.

isWorkingboolean | null
lastNamestring | null
managesThisBranchbooleanrequired

Listed as a manager of THIS branch.

namestring | null
nmlsIdstring | null
statestring | null
tenureMonthsnumber | null

Whole months at the current company, as of the weekly refresh.

yearsInIndustrynumber | null
totalnumberrequired
400objectValidation error
401objectUnauthorized
403objectForbidden (authenticated, but missing required context — e.g. no active organization)
404objectBranch not found
413objectResponse payload too large — detail endpoint capped to fit Lambda response limits
503objectSearch timed out or the cluster is overloaded — retry after `Retry-After` seconds.