Organization API

• List Organizations
• Get an Organization
• Organization API Tokens
• Organization Members (Token)
• List Organization Referrals (Token)
• Send a Referral (Token)

Organization and group IDs are also listed under My Account > Developer > Organization & Group IDs.

List Organizations

Returns the organizations the member belongs to, with the groups in each organization. No parameters are required.

Get an Organization

Returns an organization's details, including its groups. The member must belong to the organization.

Response (v3)

{
    "id": 6,
    "name": "ChamberForge",
    "created_at": "2018-02-09 17:37:26",
    "updated_at": "2022-01-22 17:35:13",
    "groups": [
        {
            "id": 33,
            "name": "Northern Virginia Referral Group",
            "created_at": "2021-11-10 10:05:38",
            "updated_at": "2022-02-10 21:14:31"
        }
    ]
}

In v4 the same organization is returned inside the data field of the response envelope.

Organization API Tokens

The endpoints above act as a member. An organization can also connect a system of its own, such as a CRM, with an organization API token. The token belongs to the organization, not to a person.

Organization Administrators and Staff create and revoke tokens under the organization's Settings > API. See API Tokens. Send the token like any other token:

Authorization: Bearer {organization_token}
Accept: application/json

An organization token only works on the /v4/organization/... endpoints below, and a member's token does not work on them. A request without a valid organization token returns 401 with the code UNAUTHORIZED.

Organization Members (Token)

GET /v4/organization/members returns the organization's Employees, Staff and Administrators with their id, name, email and role. Only these members can be named as the sender of a referral.

List Organization Referrals (Token)

GET /v4/organization/referrals returns referrals sent by the members above and referrals reported to the organization, most recently updated first.

The response's meta field holds offset, limit and total.

Each referral includes id, referral_date, status, status_name, sent_by_organization, received_by_organization, from and to (each with type, id and name), is_private, description, the lead fields, total_amount, created_at and updated_at.

• The details of a private referral (description and the lead fields) are returned as null.
• A recalled referral is not listed on the receiving side.

GET /v4/organization/referrals/{id} returns a single referral in the same shape, or 404 if the referral is not one of the organization's.

Send a Referral (Token)

POST /v4/organization/referrals sends a referral in the name of one of the organization's Employees, Staff or Administrators.

The sender and the recipient cannot be the same person. The referral is created with the status Created, and the response returns it with the status code 201. Validation errors return 422 with error.fields.