v1

latestOpenAPI 3.0.12026-07-24310590875.6 KB

partner

Get list of organizations

Get a list of organization objects. By default, you get 20 results on one page of results. Set max in your request to get up to 100 results on one page.

See Search operations with lists in the Guides section for filtering, sorting, and pagination examples.

This operation requires partner-level permissions.

A sessionId header value generated with API partner login
An appKey header value

get/v3/partner/organizations

Query parameters

maxinteger nullable

Maximum number of results

Example:10

sortstring nullable

Field name and sort order. Both simple and compound sorting is available.

The format is sort={field_01}:{sort_order},{field_02}:{sort_order}.

NOTE: Sorting occurs in the specified order.

Example:createdTime

filtersstring nullable

Field name, operator, and value. Both simple and compound filtering is available.

The format is filters={field_01}:{op}:{value},{field_02}:{op}:{value}.

Example:id:eq:{{partner_organization_id}}

pagestring nullable

Next page of results.

When a list has multiple pages, the nextPage and prevPage values in the response enable you to navigate between the pages of results. Set page as the nextPage or prevPage value for navigation.

Headers

sessionIdstring nullable

API session ID generated with /v3/partner/login

Example:{{partner_session_id}}

appKeystring nullable

Application key sent to you by BILL when you create a partner account

Example:{{app_key}}

Response

Get list of organizations response

nextPagestring

prevPagestring