List organizations

Authorizations

Authorization

string

headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-site-context

string

required

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

offset

integer

-Optional. Default:0. Number of records you wish to skip before selecting records.

limit

integer

-Optional. Default:10. Limits the number of records returned by the api.

sortOrder

enum<string>

sort directions of the retrieved records. Default value desc.

Available options:

asc,

desc

sortBy

enum<string>

sort field of the retrieved records. Default value updatedAt.

Available options:

updatedAt,

name,

email,

isActive,

partyType

id

string

-Optional. Fabric internal id of the record.

partyType

enum<string>

-Optional. Party type.

Available options:

O,

H

name

string

-Optional. Name of the organization. It can be a partial match.

traitName

string

-Optional. Filter by trait Name

isActive

boolean

-Optional. Status of the organization.

createdAt[from]

string

-Optional. Filter by createdAt using a date range. Must be accompanied by createdAt[to].

createdAt[to]

string

-Optional. Filter by createdAt using a date range. Must be accompanied by createdAt[from].

updatedAt[from]

string

-Optional. Filter by updatedAt using a date range. Must be accompanied by updatedAt[to].

updatedAt[to]

string

-Optional. Filter by updatedAt using a date range. Must be accompanied by updatedAt[from].

Response

200 - application/json

query

object

data about pagination.

Show child attributes

data

object[]

Show child attributes