List Franchisee Companies

Get the ID and name of all active franchisee companies managed by your company.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Returns a list of the active franchisee companies managed by the company that owns the API token. Inactive companies are excluded.

Use it to find a franchisee company ID, for example to pass to Retrieve Company, or to match franchisees to your own records. To include your own company in the results, pass include_self=true.

Query Params
boolean
Defaults to false

When true, includes your own company in the results alongside your franchisees.

Case-insensitive search on company name.

int32

Filter results to the given company ID.

string

Filter results to a comma-separated list of company IDs, e.g. 12,34.

int32

Number of results to return per page.

int32

The initial index from which to return the results.

Response

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json