Get Account

GET 
/crm/accounts/:accountId

Get account for a specified user and credential set

Request

Path Parameters

accountId stringrequired

The item id of the account record

Query Parameters

connectionId stringrequired

The ID of the connection.

Header Parameters

Authorization stringrequired

Default value: bearer YOUR_API_KEY

Responses

200

200

application/json

Schema

Schema

account

object

website string

industry string

addresses

object[]

Array [

country string

street1 string

state string

city string

addressType string

postalCode string

]

phoneNumbers

object[]

Array [

phoneNumberType string

phoneNumber string

]

remoteId string

lastActivityAt string

accountOwner string

accountName string

numberOfEmployees integer

Default value: 0

description string

id string

remoteCreatedAt string

remoteUpdatedAt string

remoteDeleted boolean

Default value: true

createdAt string

updatedAt string

Example (from schema)

{
  "account": {
    "website": "http://kingmanufacturing.com",
    "industry": "Manufacturing",
    "addresses": [
      {
        "country": "United States",
        "street1": "228 Runamuck Pl #2808",
        "state": "MD",
        "city": "Baltimore",
        "addressType": "main",
        "postalCode": "21224"
      }
    ],
    "phoneNumbers": [
      {
        "phoneNumberType": "main",
        "phoneNumber": "555-555-5555"
      }
    ],
    "remoteId": "0000000000000000000",
    "lastActivityAt": "2022-11-16T19:55:59+08:00",
    "accountOwner": "Gregg Mojica",
    "accountName": "King (Sample)",
    "numberOfEmployees": 445,
    "description": "King is a multinational electronics contract manufacturing company with its headquarters in Baltimore, United States.",
    "id": "00000000-0000-0000-0000-000000000000",
    "remoteCreatedAt": "2023-11-19T17:00:17.000Z",
    "remoteUpdatedAt": "2023-11-19T17:00:17.000Z",
    "remoteDeleted": false,
    "createdAt": "2024-02-22T11:17:53.264Z",
    "updatedAt": "2024-02-22T13:54:03.445Z"
  }
}

Result

{
  "account": {
    "website": "http://kingmanufacturing.com",
    "industry": "Manufacturing",
    "addresses": [
      {
        "country": "United States",
        "street1": "228 Runamuck Pl #2808",
        "state": "MD",
        "city": "Baltimore",
        "addressType": "main",
        "postalCode": "21224"
      }
    ],
    "phoneNumbers": [
      {
        "phoneNumberType": "main",
        "phoneNumber": "555-555-5555"
      }
    ],
    "remoteId": "0000000000000000000",
    "lastActivityAt": "2022-11-16T19:55:59+08:00",
    "accountOwner": "Gregg Mojica",
    "accountName": "King (Sample)",
    "numberOfEmployees": 445,
    "description": "King is a multinational electronics contract manufacturing company with its headquarters in Baltimore, United States.",
    "id": "00000000-0000-0000-0000-000000000000",
    "remoteCreatedAt": "2023-11-19T17:00:17.000Z",
    "remoteUpdatedAt": "2023-11-19T17:00:17.000Z",
    "remoteDeleted": false,
    "createdAt": "2024-02-22T11:17:53.264Z",
    "updatedAt": "2024-02-22T13:54:03.445Z"
  }
}

400

400

application/json

Schema

Schema

object

Example (from schema)

{}

Result

{}

Loading...