CRM

Retrieve all people.

Returns the people associated with your account.

get/api/v1/crm/people

Request

Base URL: https://go.outseta.com
URL: https://go.outseta.com/api/v1/crm/people
Auth: one of:
- HTTP bearer
- API key in header Authorization

Query parameters

qstring nullable

Match on the person's first or last name or email address

limitinteger

Requested page size. The server caps it at 100, or 25 when requested fields expand child objects or require additional queries; metadata.limit reports the applied value. Use offset=1 for the second page.

offsetinteger

Zero-based page number, not a record offset. With limit=50, the second page is offset=1; offset=50 is page index 50 (records 2501-2550).

Response

Example response

{
  "metadata": {
    "limit": 0,
    "offset": 0,
    "total": 0
  },
  "items": [
    {
      "Uid": "string",
      "_objectType": "string",
      "Created": "string",
      "Updated": "string",
      "ActivityEventData": {},
      "SchemaLessData": {},
      "Email": "string",
      "FirstName": "string",
      "LastName": "string",
      "MailingAddress": {},
      "PasswordLastUpdated": "string",
      "PasswordMustChange": false,
      "PhoneMobile": "string",
      "PhoneWork": "string",
      "ProfileImageS3Url": "string",
      "Title": "string",
      "Timezone": "string",
      "Language": "string",
      "IPAddress": "string",
      "Referer": "string",
      "UserAgent": "string",
      "LastLoginDateTime": "string",
      "OAuthGoogleProfileId": "string",
      "PersonAccount": [],
      "DealPeople": [],
      "LeadFormSubmissions": [],
      "Account": {},
      "AccountUids": "string",
      "EmailListPerson": [],
      "FullName": "string",
      "HasLoggedIn": false,
      "OAuthIntegrationStatus": 0,
      "OptInToEmailList": false,
      "Password": "string",
      "RecaptchaToken": "string",
      "UserAgentPlatformBrowser": "string",
      "HasUnsubscribed": false,
      "DiscordUser": {},
      "IsConnectedToDiscord": false
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.