List organizations
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Headers
The x-site-context
header is a JSON object that contains information about the source you wish to pull from. The mandatory account
is the 24 character identifier found in Copilot. The channel
(Sales channel ID), stage
(environment name), and date
attributes can be used to further narrow the scope of your data source.
Query Parameters
-Optional
. Default:0
. Number of records you wish to skip before selecting records.
-Optional
. Default:10. Limits the number of records returned by the api.
sort directions of the retrieved records. Default value desc
.
asc
, desc
sort field of the retrieved records. Default value updatedAt
.
updatedAt
, name
, email
, isActive
, partyType
-Optional
. Fabric internal id of the record.
-Optional
. Party type.
O
, H
-Optional
. Name of the organization. It can be a partial match.
-Optional
. Filter by trait Name
-Optional
. Status of the organization.
-Optional
. Filter by createdAt using a date range. Must be accompanied by createdAt[to]
.
-Optional
. Filter by createdAt using a date range. Must be accompanied by createdAt[from]
.
-Optional
. Filter by updatedAt using a date range. Must be accompanied by updatedAt[to]
.
-Optional
. Filter by updatedAt using a date range. Must be accompanied by updatedAt[from]
.
Was this page helpful?