Beamery API API Reference

Overview

The Beamery API is used to manage and enhance contact information with endpoints to create, read, update or delete contacts from the Beamery platform. Our API is RESTful and responses delivered in JSON format. The Beamery API supports SSL, and as such all requests must be made using the HTTPS protocol.

The Beamery API can be run by any authenticated user in the system as long as they have the privileges to do so.

API URLs

Environment URL Notes
Production US https://frontier.beamery.com/v1
Sandbox US https://frontier.sandbox.beamery.com/v1
Production EU https://frontier.beamery.eu/v1 For most EMEA clients you will have both your sandbox and production tenants on this environment

Please confirm which environment your tenant is on with your Customer Success Manager (CSM) before attempting to use our Public API

You will need to suffix the above urls with /v1 whenever using a call. For example, if making a call to the /users endpoint on the sandbox environment, your full request url should be:

https://frontier.sandbox.beamery.com/v1/users

In order to work with the API you will need a Beamery user with the API user role ACL, reach out to your CSM for support in creating the user.

Rate Limits

The Beamery API is protected by a rate limiter, which uses Requests Per Second as the unit.

The limits are the following:

  • Authentication endpoint limit: 30 RPS
  • Per Company limit: 40 RPS

There are additional safety measures applied to Beamery PublicAPI that could return 429 under conditions of extreme load,
even if described capacity has still not been exceeded.

How to authenticate

Authentication with the Beamery public API requires you to have a token in the request header called “Authorization”.

To get this token you will need to do a GET call to /v1/auth with the username and password formatted as username:password and encrypted as Base64

e.g. If your username is [email protected] and your password is Beamery$123, then your authentication should send a Base64 encrypted string of [email protected]:Beamery$123.

If using Postman: this can be done by using the authorization type “Basic Auth” from the authorization tab on the postman request.

The response will be { “token” : “STRING” }, containing a string token that you can add to the authorization header as a string.

Postman Starter Collection

We find that most customers prefer to play around in their sandbox tenant with the public API using Postman to get accustomed to our public API endpoints and behaviour before building anything.

For this, we have prepared the below Postman collection. It is not an exhaustive list of endpoints, however it provides a good level of detail for what is possible.

See the External Postman collection here.

This collection also has two variables that are necessary to use:

beamery-frontier-jwt-token this variable should contain the authorization token, and if you use the Authenticate User Get call under the “01 - Auth” folder, there is a script that will run post request run that will add the token automatically into this variable.

api-url this variable contains the api url that you are connecting to, for example if you are connecting to the sandbox environment, it will be https://frontier.sandbox.beamery.com

Request Content-Types: application/json
Response Content-Types: application/json
Schemes: http
Version: 0.0.1

Authentication

isAuthenticated

type
apiKey
name
Authorization
in
header

isRegistered

type
basic

acl

acl

Get user ACL

GET /acl/user/{userid}

Gets the roles and responsibilities for a particular user. Requires the userid as a parameter. On success, the payload references the ACL Roles model to return a list of roles associated with that user. References the Success model and the Error model.

userid: string
in path

References the unique user id for the user in the User model

200 OK

OK

400 Bad Request

Bad Request

401 Unauthorized

Unauthorized

404 Not Found

User not found

500 Internal Server Error

Internal server error

503 Service Unavailable

The requested service is unavailable

default

unexpected error

Response Example (200 OK)
[
  "super_admin"
]
Response Example (400 Bad Request)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (503 Service Unavailable)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
acl

Update user ACL

PUT /acl/user/{userid}

Grants a role on the object for a particular user. Requires the userid and a role as parameters. References the unique user id for the user in the User model the ACL Roles model to modify roles associated with that user. References the Success model and the Error model.

References the ACL Roles model to modify roles associated with a particular user. Current Beamery roles are:

Role Name Role string for API
Super Admin ["super_admin"]
Sourcing Admin ["admin"]
Sourcing Standard ["team_member"]
Sourcing Limited ["limited"]
Marketing Admin ["marketing_admin"]
Marketing Standard ["marketing_team_member"]
Marketing Limited ["marketing_limited"]
Restricted ["restricted"]
Sourcing Confidential ["confidential"]
Recruiter Standard ["recruiter_team_member"]
Recruiter Confidential ["recruiter_confidential"]
userid: string
in path

References the unique user id for the user in the User model.

Request Example
[
  "super_admin"
]
200 OK

OK

400 Bad Request

Bad Request

401 Unauthorized

Unauthorized

404 Not Found

User not found

500 Internal Server Error

Internal server error

503 Service Unavailable

The requested service is unavailable

default

unexpected error

Response Example (400 Bad Request)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (503 Service Unavailable)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}

auth

Authenticates the user and returns an encrypted JSON Web token if the user's credentials are successfully validated. There are no parameters as it uses Basic Authentication scheme to transmit its credentials.

  • Token lifetime policy – tokens live for 24 hours.

Authenticate user

GET /auth

Authenticates the user and returns a token if the user's credentials are successfully validated. There are no parameters as it takes the user's credentials from the Authorization HTTP header with format "BASIC XXXXX", where "XXXXX" is the Base64(username:password).

If the user is successfully authenticated, it returns the HTTP 200 status code and token, that can be Base64 decoded to retrieve token expiry time. References the Success model and the Error model.

200 OK

Returns a token specific to you, including Base64 encoded expiry.

type
object
400 Bad Request

Bad Request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

User not found

500 Internal Server Error

Internal server error

default

unexpected error

Response Example (200 OK)
{
  "id": 100,
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
}
Response Example (400 Bad Request)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}

attractEvents

Lets you create, view, update, cancel and delete your Beamery platform attarct events.

Create Attract Event

POST /attractEvents

Create new attract event

References all the attributes in the Attract Event model except id which is uniquely generated by the system.

Request Example
{
  "customFields": [
    {
      "id": "string",
      "name": "string",
      "optionIds": [
        {
          "id": "string"
        }
      ],
      "options": [
        {
          "id": "string",
          "label": "string"
        }
      ],
      "required": "boolean",
      "type": "string",
      "value": "string"
    }
  ],
  "description": "string",
  "end": {
    "date": "string",
    "time": "string",
    "timestamp": "string"
  },
  "image": {
    "name": "string",
    "url": "string"
  },
  "location": {
    "address": "string",
    "address2": "string",
    "city": "string",
    "country": "string",
    "county": "string",
    "formattedAddress": "string",
    "geoPoint": {
      "lat": "number",
      "lon": "number"
    },
    "lat": "number",
    "lng": "number",
    "name": "string",
    "postcode": "string",
    "url": "string"
  },
  "locationType": "string",
  "locationUrl": "string",
  "name": "string",
  "start": {
    "date": "string",
    "time": "string",
    "timestamp": "string"
  },
  "status": "string",
  "type": "string"
}
200 OK

OK

400 Bad Request

Bad Request

401 Unauthorized

Unauthorized

500 Internal Server Error

Internal server error

503 Service Unavailable

The requested service is unavailable

default

unexpected error

Response Example (200 OK)
{
  "cancelledAt": "string",
  "cancelledBy": "string",
  "companyId": "string",
  "createdAt": "string",
  "createdBy": "string",
  "customFields": [
    {
      "createdAt": "string",
      "createdBy": "string",
      "id": "string",
      "name": "string",
      "optionIds": [
        {
          "id": "string"
        }
      ],
      "options": [
        {
          "id": "string",
          "label": "string"
        }
      ],
      "required": "boolean",
      "type": "string",
      "updatedAt": "string",
      "updatedBy": "string",
      "value": "string"
    }
  ],
  "deletedAt": "string",
  "deletedBy": "string",
  "description": "string",
  "end": {
    "date": "string",
    "time": "string",
    "timestamp": "string"
  },
  "id": "string",
  "image": {
    "name": "string",
    "url": "string"
  },
  "location": {
    "address": "string",
    "address2": "string",
    "city": "string",
    "country": "string",
    "county": "string",
    "formattedAddress": "string",
    "geoPoint": {
      "lat": "number",
      "lon": "number"
    },
    "lat": "number",
    "lng": "number",
    "name": "string",
    "postcode": "string",
    "url": "string"
  },
  "locationType": "string",
  "locationUrl": "string",
  "metrics": {
    "attendanceRate": "number",
    "funnel": {
      "attended": "integer (int32)",
      "invited": "integer (int32)",
      "prospect": "integer (int32)",
      "registered": "integer (int32)"
    },
    "funnelList": [
      {
        "count": "integer (int32)",
        "id": "string",
        "name": "string"
      }
    ]
  },
  "name": "string",
  "owner": {
    "firstName": "string",
    "fullName": "string",
    "id": "string",
    "lastName": "string"
  },
  "relations": {
    "flowCheckIn": {
      "id": "string",
      "latestPublishedSlug": "string",
      "publicUrl": "string",
      "status": "string"
    },
    "flowReg": {
      "id": "string",
      "latestPublishedSlug": "string",
      "publicUrl": "string",
      "status": "string"
    },
    "page": {
      "builderUrl": "string",
      "id": "string"
    }
  }
}
Response Example (400 Bad Request)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (503 Service Unavailable)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}

Clone Attract Event

POST /attractEvents/clone/{attractEventId}

Clone attract event

References all the attributes in the Attract Event model except id which is uniquely generated by the system.

attractEventId: string
in path

References the unique attract event id in the Attract Event model used to clone content.

Request Example
{
  "end": {
    "date": "string",
    "time": "string",
    "timestamp": "string"
  },
  "name": "string",
  "start": {
    "date": "string",
    "time": "string",
    "timestamp": "string"
  }
}
200 OK

OK

400 Bad Request

Bad Request

401 Unauthorized

Unauthorized

500 Internal Server Error

Internal server error

503 Service Unavailable

The requested service is unavailable

default

unexpected error

Response Example (200 OK)
{
  "cancelledAt": "string",
  "cancelledBy": "string",
  "companyId": "string",
  "createdAt": "string",
  "createdBy": "string",
  "customFields": [
    {
      "createdAt": "string",
      "createdBy": "string",
      "id": "string",
      "name": "string",
      "optionIds": [
        {
          "id": "string"
        }
      ],
      "options": [
        {
          "id": "string",
          "label": "string"
        }
      ],
      "required": "boolean",
      "type": "string",
      "updatedAt": "string",
      "updatedBy": "string",
      "value": "string"
    }
  ],
  "deletedAt": "string",
  "deletedBy": "string",
  "description": "string",
  "end": {
    "date": "string",
    "time": "string",
    "timestamp": "string"
  },
  "id": "string",
  "image": {
    "name": "string",
    "url": "string"
  },
  "location": {
    "address": "string",
    "address2": "string",
    "city": "string",
    "country": "string",
    "county": "string",
    "formattedAddress": "string",
    "geoPoint": {
      "lat": "number",
      "lon": "number"
    },
    "lat": "number",
    "lng": "number",
    "name": "string",
    "postcode": "string",
    "url": "string"
  },
  "locationType": "string",
  "locationUrl": "string",
  "metrics": {
    "attendanceRate": "number",
    "funnel": {
      "attended": "integer (int32)",
      "invited": "integer (int32)",
      "prospect": "integer (int32)",
      "registered": "integer (int32)"
    },
    "funnelList": [
      {
        "count": "integer (int32)",
        "id": "string",
        "name": "string"
      }
    ]
  },
  "name": "string",
  "owner": {
    "firstName": "string",
    "fullName": "string",
    "id": "string",
    "lastName": "string"
  },
  "relations": {
    "flowCheckIn": {
      "id": "string",
      "latestPublishedSlug": "string",
      "publicUrl": "string",
      "status": "string"
    },
    "flowReg": {
      "id": "string",
      "latestPublishedSlug": "string",
      "publicUrl": "string",
      "status": "string"
    },
    "page": {
      "builderUrl": "string",
      "id": "string"
    }
  }
}
Response Example (400 Bad Request)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (503 Service Unavailable)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}

Get list of attract events location types

GET /attractEvents/locationtypes

Get list of attract events location types

400 Bad Request

Bad Request

401 Unauthorized

Unauthorized

404 Not Found

The specified resource was not found

500 Internal Server Error

Internal server error

503 Service Unavailable

The requested service is unavailable

default

unexpected error

Response Example (200 OK)
[
  {
    "id": "string",
    "label": "string"
  }
]
Response Example (400 Bad Request)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (503 Service Unavailable)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}

List of attract events

POST /attractEvents/search

Retrieves a list of attract events.

The filter request

data: object[]
object
FULL_TEXT_PREFIX: object
op: string FULL_TEXT_PREFIX
value: string

The search string

createdAt: object
op: string LTE, GTE, EQ, GT, LT
value: string | null
customFields: object
deletedAt: object
op: string LTE, GTE, EQ, GT, LT
value: string | null
end/timestamp: object
location/address: object
op: string
value: string
location/address2: object
op: string
value: string
location/city: object
op: string
value: string
location/country: object
op: string
value: string
location/county: object
op: string
value: string
location/formattedAddress: object
location/geoPoint: object
location/name: object
op: string
value: string
location/postcode: object
op: string
value: string
location/url: object
op: string
value: string
locationType: object
owner/id: object
op: string ALL, ANY
value: object[]
object
op: string EQ
value: string
start/timestamp: object
timezone/id: object
timezone/name: object
timezone/value: object
type: object
op: string ALL, ANY
value: object[]
object
op: string EQ
value: string campus, careerFair, conference, hackathon, meetup, networking, openDay, webinar, other
updatedAt: object
op: string LTE, GTE, EQ, GT, LT
value: string | null
limit: integer (int32)
skip: integer (int32)
sortDir: string ASC, DESC

Sort order: * ASC - Ascending, from A to Z * DESC - Descending, from Z to A

sortFieldId: string
Request Example
{
  "data": [
    {
      "FULL_TEXT_PREFIX": {
        "op": "string",
        "value": "search string"
      },
      "createdAt": {
        "op": "string",
        "value": "2015-09-01T00:00:00.0000"
      },
      "customFields": "object",
      "deletedAt": {
        "op": "string",
        "value": "2015-09-01T00:00:00.0000"
      },
      "end/timestamp": {
        "op": "LT",
        "value": "2020-09-01T00:00:00.0000"
      },
      "location/address": {
        "op": "string",
        "value": "string"
      },
      "location/address2": {
        "op": "string",
        "value": "string"
      },
      "location/city": {
        "op": "EQ",
        "value": "San Francisco"
      },
      "location/country": {
        "op": "EQ",
        "value": "United States"
      },
      "location/county": {
        "op": "string",
        "value": "string"
      },
      "location/formattedAddress": "object",
      "location/geoPoint": "object",
      "location/name": {
        "op": "string",
        "value": "string"
      },
      "location/postcode": {
        "op": "string",
        "value": "string"
      },
      "location/url": {
        "op": "string",
        "value": "string"
      },
      "locationType": {
        "op": "EQ",
        "value": "virtual_physical"
      },
      "owner/id": {
        "op": "string",
        "value": [
          {
            "op": "string",
            "value": "<userId>"
          }
        ]
      },
      "start/timestamp": {
        "op": "GT",
        "value": "2015-09-01T00:00:00.0000"
      },
      "timezone/id": "object",
      "timezone/name": "object",
      "timezone/value": "object",
      "type": {
        "op": "string",
        "value": [
          {
            "op": "string",
            "value": "campus"
          }
        ]
      },
      "updatedAt": {
        "op": "string",
        "value": "2015-09-01T00:00:00.0000"
      }
    }
  ],
  "limit": 20,
  "skip": "integer (int32)",
  "sortDir": "string",
  "sortFieldId": "name"
}

OK

401 Unauthorized

Unauthorized

500 Internal Server Error

Internal server error

503 Service Unavailable

The requested service is unavailable

default

unexpected error

Response Example (200 OK)
{
  "data": [
    {
      "cancelledAt": "string",
      "cancelledBy": "string",
      "companyId": "string",
      "createdAt": "string",
      "createdBy": "string",
      "customFields": [
        {
          "createdAt": "string",
          "createdBy": "string",
          "id": "string",
          "name": "string",
          "optionIds": [
            {
              "id": "string"
            }
          ],
          "options": [
            {
              "id": "string",
              "label": "string"
            }
          ],
          "required": "boolean",
          "type": "string",
          "updatedAt": "string",
          "updatedBy": "string",
          "value": "string"
        }
      ],
      "deletedAt": "string",
      "deletedBy": "string",
      "description": "string",
      "end": {
        "date": "string",
        "time": "string",
        "timestamp": "string"
      },
      "id": "string",
      "image": {
        "name": "string",
        "url": "string"
      },
      "location": {
        "address": "string",
        "address2": "string",
        "city": "string",
        "country": "string",
        "county": "string",
        "formattedAddress": "string",
        "geoPoint": {
          "lat": "number",
          "lon": "number"
        },
        "lat": "number",
        "lng": "number",
        "name": "string",
        "postcode": "string",
        "url": "string"
      },
      "locationType": "string",
      "locationUrl": "string",
      "metrics": {
        "attendanceRate": "number",
        "funnel": {
          "attended": "integer (int32)",
          "invited": "integer (int32)",
          "prospect": "integer (int32)",
          "registered": "integer (int32)"
        },
        "funnelList": [
          {
            "count": "integer (int32)",
            "id": "string",
            "name": "string"
          }
        ]
      },
      "name": "string",
      "owner": {
        "firstName": "string",
        "fullName": "string",
        "id": "string",
        "lastName": "string"
      },
      "relations": {
        "flowCheckIn": {
          "id": "string",
          "latestPublishedSlug": "string",
          "publicUrl": "string",
          "status": "string"
        },
        "flowReg": {
          "id": "string",
          "latestPublishedSlug": "string",
          "publicUrl": "string",
          "status": "string"
        }
      }
    }
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (503 Service Unavailable)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}

Get list of attract events types

GET /attractEvents/types

Get list of attract events types

OK

400 Bad Request

Bad Request

401 Unauthorized

Unauthorized

404 Not Found

The specified resource was not found

500 Internal Server Error

Internal server error

503 Service Unavailable

The requested service is unavailable

default

unexpected error

Response Example (200 OK)
[
  {
    "id": "string",
    "label": "string"
  }
]
Response Example (400 Bad Request)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (503 Service Unavailable)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}

Get attract event

GET /attractEvents/{attractEventId}

Retrieves the details of a particular attract event. Requires the attractEventId as a parameter. If the attractEventId exists, and the details of that particular attractEvent has been successfully retrieved, it returns the HTTP 200 status code. The payload will display the values associated with the attributes for that attract event. References the Success model and the Error model.

attractEventId: string
in path

References the unique attract event id in the Attract Event model used to retrieve the attract event's details.

400 Bad Request

Bad Request

401 Unauthorized

Unauthorized

404 Not Found

The specified resource was not found

500 Internal Server Error

Internal server error

503 Service Unavailable

The requested service is unavailable

default

unexpected error

Response Example (200 OK)
{
  "cancelledAt": "string",
  "cancelledBy": "string",
  "companyId": "string",
  "createdAt": "string",
  "createdBy": "string",
  "customFields": [
    {
      "createdAt": "string",
      "createdBy": "string",
      "id": "string",
      "name": "string",
      "optionIds": [
        {
          "id": "string"
        }
      ],
      "options": [
        {
          "id": "string",
          "label": "string"
        }
      ],
      "required": "boolean",
      "type": "string",
      "updatedAt": "string",
      "updatedBy": "string",
      "value": "string"
    }
  ],
  "deletedAt": "string",
  "deletedBy": "string",
  "description": "string",
  "end": {
    "date": "string",
    "time": "string",
    "timestamp": "string"
  },
  "id": "string",
  "image": {
    "name": "string",
    "url": "string"
  },
  "location": {
    "address": "string",
    "address2": "string",
    "city": "string",
    "country": "string",
    "county": "string",
    "formattedAddress": "string",
    "geoPoint": {
      "lat": "number",
      "lon": "number"
    },
    "lat": "number",
    "lng": "number",
    "name": "string",
    "postcode": "string",
    "url": "string"
  },
  "locationType": "string",
  "locationUrl": "string",
  "metrics": {
    "attendanceRate": "number",
    "funnel": {
      "attended": "integer (int32)",
      "invited": "integer (int32)",
      "prospect": "integer (int32)",
      "registered": "integer (int32)"
    },
    "funnelList": [
      {
        "count": "integer (int32)",
        "id": "string",
        "name": "string"
      }
    ]
  },
  "name": "string",
  "owner": {
    "firstName": "string",
    "fullName": "string",
    "id": "string",
    "lastName": "string"
  },
  "relations": {
    "flowCheckIn": {
      "builderUrl": "string",
      "flow": {
        "companyId": "string",
        "id": "string",
        "latestPublishedSlug": "string",
        "latestPublishedVersions": "object",
        "latestVersions": "object",
        "name": "string",
        "status": "string"
      }
    }
  }
}
Response Example (400 Bad Request)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (503 Service Unavailable)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}

Update attract event

PUT /attractEvents/{attractEventId}

Update attract event by id

References all the attributes in the Attract Event model except id which is uniquely generated by the system.

attractEventId: string
in path

References the unique attract event id in the Attract Event model used to update the Attract Event's details.

Request Example
{
  "customFields": [
    {
      "id": "string",
      "name": "string",
      "optionIds": [
        {
          "id": "string"
        }
      ],
      "options": [
        {
          "id": "string",
          "label": "string"
        }
      ],
      "required": "boolean",
      "type": "string",
      "value": "string"
    }
  ],
  "description": "string",
  "end": {
    "date": "string",
    "time": "string",
    "timestamp": "string"
  },
  "image": {
    "name": "string",
    "url": "string"
  },
  "location": {
    "address": "string",
    "address2": "string",
    "city": "string",
    "country": "string",
    "county": "string",
    "formattedAddress": "string",
    "geoPoint": {
      "lat": "number",
      "lon": "number"
    },
    "lat": "number",
    "lng": "number",
    "name": "string",
    "postcode": "string",
    "url": "string"
  },
  "locationType": "string",
  "locationUrl": "string",
  "name": "string",
  "start": {
    "date": "string",
    "time": "string",
    "timestamp": "string"
  },
  "status": "string",
  "type": "string"
}
200 OK

OK

400 Bad Request

Bad Request

401 Unauthorized

Unauthorized

404 Not Found

AttractEvent not found

500 Internal Server Error

Internal server error

503 Service Unavailable

The requested service is unavailable

default

unexpected error

Response Example (200 OK)
{
  "cancelledAt": "string",
  "cancelledBy": "string",
  "companyId": "string",
  "createdAt": "string",
  "createdBy": "string",
  "customFields": [
    {
      "createdAt": "string",
      "createdBy": "string",
      "id": "string",
      "name": "string",
      "optionIds": [
        {
          "id": "string"
        }
      ],
      "options": [
        {
          "id": "string",
          "label": "string"
        }
      ],
      "required": "boolean",
      "type": "string",
      "updatedAt": "string",
      "updatedBy": "string",
      "value": "string"
    }
  ],
  "deletedAt": "string",
  "deletedBy": "string",
  "description": "string",
  "end": {
    "date": "string",
    "time": "string",
    "timestamp": "string"
  },
  "id": "string",
  "image": {
    "name": "string",
    "url": "string"
  },
  "location": {
    "address": "string",
    "address2": "string",
    "city": "string",
    "country": "string",
    "county": "string",
    "formattedAddress": "string",
    "geoPoint": {
      "lat": "number",
      "lon": "number"
    },
    "lat": "number",
    "lng": "number",
    "name": "string",
    "postcode": "string",
    "url": "string"
  },
  "locationType": "string",
  "locationUrl": "string",
  "metrics": {
    "attendanceRate": "number",
    "funnel": {
      "attended": "integer (int32)",
      "invited": "integer (int32)",
      "prospect": "integer (int32)",
      "registered": "integer (int32)"
    },
    "funnelList": [
      {
        "count": "integer (int32)",
        "id": "string",
        "name": "string"
      }
    ]
  },
  "name": "string",
  "owner": {
    "firstName": "string",
    "fullName": "string",
    "id": "string",
    "lastName": "string"
  },
  "relations": {
    "flowCheckIn": {
      "id": "string",
      "latestPublishedSlug": "string",
      "publicUrl": "string",
      "status": "string"
    },
    "flowReg": {
      "id": "string",
      "latestPublishedSlug": "string",
      "publicUrl": "string",
      "status": "string"
    },
    "page": {
      "builderUrl": "string",
      "id": "string"
    }
  }
}
Response Example (400 Bad Request)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (503 Service Unavailable)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}

Delete attract event

DELETE /attractEvents/{attractEventId}

Delete (Soft) attract event by id

attractEventId: string
in path

References the unique attractEvent id in the Attract Event model used to delete the attract event.

204 No Content

No Content

400 Bad Request

Bad Request

401 Unauthorized

Unauthorized

404 Not Found

The specified resource was not found

500 Internal Server Error

Internal server error

503 Service Unavailable

The requested service is unavailable

default

unexpected error

Response Example (400 Bad Request)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (503 Service Unavailable)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}

Cancel attract event

POST /attractEvents/{attractEventId}/cancel

Cancel attract event by id

attractEventId: string
in path

References the unique attract event id in the Attract Event model used to cancel the Attract Event.

200 OK

OK

400 Bad Request

Bad Request

401 Unauthorized

Unauthorized

404 Not Found

AttractEvent not found

500 Internal Server Error

Internal server error

503 Service Unavailable

The requested service is unavailable

default

unexpected error

Response Example (200 OK)
{
  "cancelledAt": "string",
  "cancelledBy": "string",
  "companyId": "string",
  "createdAt": "string",
  "createdBy": "string",
  "customFields": [
    {
      "createdAt": "string",
      "createdBy": "string",
      "id": "string",
      "name": "string",
      "optionIds": [
        {
          "id": "string"
        }
      ],
      "options": [
        {
          "id": "string",
          "label": "string"
        }
      ],
      "required": "boolean",
      "type": "string",
      "updatedAt": "string",
      "updatedBy": "string",
      "value": "string"
    }
  ],
  "deletedAt": "string",
  "deletedBy": "string",
  "description": "string",
  "end": {
    "date": "string",
    "time": "string",
    "timestamp": "string"
  },
  "id": "string",
  "image": {
    "name": "string",
    "url": "string"
  },
  "location": {
    "address": "string",
    "address2": "string",
    "city": "string",
    "country": "string",
    "county": "string",
    "formattedAddress": "string",
    "geoPoint": {
      "lat": "number",
      "lon": "number"
    },
    "lat": "number",
    "lng": "number",
    "name": "string",
    "postcode": "string",
    "url": "string"
  },
  "locationType": "string",
  "locationUrl": "string",
  "metrics": {
    "attendanceRate": "number",
    "funnel": {
      "attended": "integer (int32)",
      "invited": "integer (int32)",
      "prospect": "integer (int32)",
      "registered": "integer (int32)"
    },
    "funnelList": [
      {
        "count": "integer (int32)",
        "id": "string",
        "name": "string"
      }
    ]
  },
  "name": "string",
  "owner": {
    "firstName": "string",
    "fullName": "string",
    "id": "string",
    "lastName": "string"
  },
  "relations": {
    "flowCheckIn": {
      "id": "string",
      "latestPublishedSlug": "string",
      "publicUrl": "string",
      "status": "string"
    },
    "flowReg": {
      "id": "string",
      "latestPublishedSlug": "string",
      "publicUrl": "string",
      "status": "string"
    },
    "page": {
      "builderUrl": "string",
      "id": "string"
    }
  }
}
Response Example (400 Bad Request)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (503 Service Unavailable)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}

attractEventCustomFields

Lets you create, view, update, and delete your Beamery platform attarct event custom fields.

Get list of event custom fields

GET /attractEvents/customfields

Get list of attract event custom fields

400 Bad Request

Bad Request

401 Unauthorized

Unauthorized

500 Internal Server Error

Internal server error

503 Service Unavailable

The requested service is unavailable

default

unexpected error

Response Example (200 OK)
{
  "customFields": [
    {
      "createdAt": "string",
      "createdBy": "string",
      "id": "string",
      "name": "string",
      "options": [
        {
          "id": "string",
          "label": "string"
        }
      ],
      "required": "boolean",
      "type": "string",
      "updatedAt": "string",
      "updatedBy": "string"
    }
  ],
  "total": "integer (int32)"
}
Response Example (400 Bad Request)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (503 Service Unavailable)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}

Create event custom field

POST /attractEvents/customfields

Create new event custom field

New attract event custom field properties

Request Example
{
  "name": "string",
  "options": [
    {
      "id": "string",
      "label": "string"
    }
  ],
  "required": "boolean",
  "type": "string"
}
400 Bad Request

Bad Request

401 Unauthorized

Unauthorized

500 Internal Server Error

Internal server error

503 Service Unavailable

The requested service is unavailable

default

unexpected error

Response Example (200 OK)
{
  "createdAt": "string",
  "createdBy": "string",
  "id": "string",
  "name": "string",
  "options": [
    {
      "id": "string",
      "label": "string"
    }
  ],
  "required": "boolean",
  "type": "string",
  "updatedAt": "string",
  "updatedBy": "string"
}
Response Example (400 Bad Request)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (503 Service Unavailable)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}

Get event custom field by id

GET /attractEvents/customfields/{customFieldId}

Get attract event custom field by id

customFieldId: string
in path

References the unique attract event custom field id.

400 Bad Request

Bad Request

401 Unauthorized

Unauthorized

404 Not Found

AttractEvent custom field not found

500 Internal Server Error

Internal server error

503 Service Unavailable

The requested service is unavailable

default

unexpected error

Response Example (200 OK)
{
  "createdAt": "string",
  "createdBy": "string",
  "id": "string",
  "name": "string",
  "options": [
    {
      "id": "string",
      "label": "string"
    }
  ],
  "required": "boolean",
  "type": "string",
  "updatedAt": "string",
  "updatedBy": "string"
}
Response Example (400 Bad Request)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (503 Service Unavailable)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}

Delete event custom field by id

DELETE /attractEvents/customfields/{customFieldId}

Delete attract event custom field by id

customFieldId: string
in path

References the unique attract event custom field id.

400 Bad Request

Bad Request

401 Unauthorized

Unauthorized

404 Not Found

AttractEvent custom field not found

500 Internal Server Error

Internal server error

503 Service Unavailable

The requested service is unavailable

default

unexpected error

Response Example (200 OK)
{
  "createdAt": "string",
  "createdBy": "string",
  "id": "string",
  "name": "string",
  "options": [
    {
      "id": "string",
      "label": "string"
    }
  ],
  "required": "boolean",
  "type": "string",
  "updatedAt": "string",
  "updatedBy": "string"
}
Response Example (400 Bad Request)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (503 Service Unavailable)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}

Update event custom field by id

PATCH /attractEvents/customfields/{customFieldId}

Update attract event custom field by id

New attract event custom field properties

customFieldId: string
in path

References the unique attract event custom field id.

Request Example
{
  "name": "string",
  "options": [
    {
      "id": "string",
      "label": "string"
    }
  ],
  "required": "boolean"
}
400 Bad Request

Bad Request

401 Unauthorized

Unauthorized

404 Not Found

AttractEvent custom field not found

500 Internal Server Error

Internal server error

503 Service Unavailable

The requested service is unavailable

default

unexpected error

Response Example (200 OK)
{
  "createdAt": "string",
  "createdBy": "string",
  "id": "string",
  "name": "string",
  "options": [
    {
      "id": "string",
      "label": "string"
    }
  ],
  "required": "boolean",
  "type": "string",
  "updatedAt": "string",
  "updatedBy": "string"
}
Response Example (400 Bad Request)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (503 Service Unavailable)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}

contact

Lets you create, view, update, delete, export your Beamery platform contacts as well as share or unshare their details with nominated teams or users and list deleted contacts. If the contact has been migrated across from an external ATS or system, you can flag that record by simply populating an integration attribute which creates a reference to the originating contact.

Create contact

POST /contact

Creates a new contact. If the new contact has been successfully created, it returns the HTTP 200 status code and the payload will display the values associated with the attributes you added earlier. References the Success model and the Error model.

If a request contains the same email, integrations>id field, or has matching links of an existing contact, no new contact will be created and the existing contact will be updated instead. An HTTP 200 status code will be returned along with the updated contact.

If a request contains values for assignedTo or sourcedBy, the endpoint will check if the specified user id exists. If not, a 400 is returned. If no values are specified these fields default to the id of the user making the request.

Contact collection values, such as those inside experience or education, are not displayed in deterministic order.

References all the attributes in the Contact model except id which is uniquely generated by the system.

Request Example
{
  "assignedTo": "8a45c737-f580-4730-b9d1-92dd38502973",
  "confidential": "boolean",
  "confidentiality": {
    "mode": "shares-only",
    "shares": {
      "teams": [
        "string"
      ],
      "users": [
        "string"
      ]
    }
  },
  "createdTime": "string (date-time)",
  "creationSource": {
    "id": "string",
    "value": "string"
  },
  "customFields": [
    {
      "displayName": "string",
      "displayValue": "string",
      "id": "string",
      "name": "string",
      "value": "string",
      "values": [
        "string"
      ],
      "visibleTo": [
        "string"
      ]
    }
  ],
  "doNotContact": false,
  "education": [
    {
      "current": true,
      "degree": "Master of CSc",
      "endDate": "2015-11-17T18:45:01Z",
      "grade": "string",
      "id": "id-0000002",
      "major": "string",
      "organisationName": "Teradata",
      "program": "string",
      "startDate": "2015-11-17T18:45:00Z"
    }
  ],
  "emails": [
    "[email protected]"
  ],
  "experience": [
    {
      "current": true,
      "description": "Professional Services Consultant with multiple responsabilities",
      "endDate": "2015-11-17T18:45:01Z",
      "id": "id-0000002",
      "organisationName": "Teradata",
      "role": "Professional Services Consultant",
      "startDate": "2015-11-17T18:45:00Z"
    }
  ],
  "firstName": "Bruce",
  "fullName": "Bruce Wayne",
  "gdprConsent": "boolean",
  "gdprConsentDate": "string (date-time)",
  "globalTags": [
    {
      "id": "string",
      "value": "string"
    }
  ],
  "id": "string",
  "integrations": {
    "brassring": {
      "id": "string",
      "url": "string"
    },
    "greenhouse": {
      "email": "string",
      "id": "string",
      "url": "string"
    },
    "jazz": {
      "id": "string"
    },
    "successfactors": {
      "id": "string",
      "url": "string"
    },
    "taleo": {
      "id": "string",
      "url": "string"
    },
    "workday": {
      "id": "string",
      "skills": [
        {
          "id": "string",
          "name": "string"
        }
      ],
      "url": "string"
    }
  },
  "languages": [
    {
      "languageCode": "string",
      "value": "string"
    }
  ]
}
200 OK

OK

201 Created

Created

400 Bad Request

Bad Request

401 Unauthorized

Unauthorized

409 Conflict

Conflict

500 Internal Server Error

Internal server error

503 Service Unavailable

The requested service is unavailable

default

unexpected error

Response Example (200 OK)
{
  "assignedTo": "8a45c737-f580-4730-b9d1-92dd38502973",
  "confidential": "boolean",
  "confidentiality": {
    "mode": "shares-only",
    "shares": {
      "teams": [
        "string"
      ],
      "users": [
        "string"
      ]
    }
  },
  "createdTime": "string (date-time)",
  "creationSource": {
    "id": "string",
    "value": "string"
  },
  "customFields": [
    {
      "displayName": "string",
      "displayValue": "string",
      "id": "string",
      "name": "string",
      "value": "string",
      "values": [
        "string"
      ],
      "visibleTo": [
        "string"
      ]
    }
  ],
  "doNotContact": false,
  "education": [
    {
      "current": true,
      "degree": "Master of CSc",
      "endDate": "2015-11-17T18:45:01Z",
      "grade": "string",
      "id": "id-0000002",
      "major": "string",
      "organisationName": "Teradata",
      "program": "string",
      "startDate": "2015-11-17T18:45:00Z"
    }
  ],
  "emails": [
    "[email protected]"
  ],
  "experience": [
    {
      "current": true,
      "description": "Professional Services Consultant with multiple responsabilities",
      "endDate": "2015-11-17T18:45:01Z",
      "id": "id-0000002",
      "organisationName": "Teradata",
      "role": "Professional Services Consultant",
      "startDate": "2015-11-17T18:45:00Z"
    }
  ],
  "firstName": "Bruce",
  "fullName": "Bruce Wayne",
  "gdprConsent": "boolean",
  "gdprConsentDate": "string (date-time)",
  "globalTags": [
    {
      "id": "string",
      "value": "string"
    }
  ],
  "id": "string",
  "integrations": {
    "brassring": {
      "id": "string",
      "url": "string"
    },
    "greenhouse": {
      "email": "string",
      "id": "string",
      "url": "string"
    },
    "jazz": {
      "id": "string"
    },
    "successfactors": {
      "id": "string",
      "url": "string"
    },
    "taleo": {
      "id": "string",
      "url": "string"
    },
    "workday": {
      "id": "string",
      "skills": [
        {
          "id": "string",
          "name": "string"
        }
      ],
      "url": "string"
    }
  },
  "languages": [
    {
      "languageCode": "string",
      "value": "string"
    }
  ]
}
Response Example (400 Bad Request)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (409 Conflict)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (503 Service Unavailable)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}

Get contact using name of external ATS or system and contact id

GET /contact/external/{partnername}/{externalid}

If the contact was migrated from an external ATS or system, you can retrieve the details of that particular contact by using a combination of the name of the originating ATS or system together with the contact id from that system. Requires the partnername and externalid as parameters.

If the combination of partnername and externalid exists, and the details of that particular contact has been successfully retrieved, it returns the HTTP 200 status code. he payload will display the values associated with the attributes for that contact. References the Success model and the Error model.

partnername: string
in path

References the name of the originating ATS or system in the Integration model.

externalid: string
in path

References the unique contact id in the Contact model used to retrieve the contact's details.

200 OK

OK

400 Bad Request

Bad Request

401 Unauthorized

Unauthorized

404 Not Found

The specified resource was not found

500 Internal Server Error

Internal server error

Response Example (200 OK)
{
  "assignedTo": "8a45c737-f580-4730-b9d1-92dd38502973",
  "confidential": "boolean",
  "confidentiality": {
    "mode": "shares-only",
    "shares": {
      "teams": [
        "string"
      ],
      "users": [
        "string"
      ]
    }
  },
  "createdTime": "string (date-time)",
  "creationSource": {
    "id": "string",
    "value": "string"
  },
  "customFields": [
    {
      "displayName": "string",
      "displayValue": "string",
      "id": "string",
      "name": "string",
      "value": "string",
      "values": [
        "string"
      ],
      "visibleTo": [
        "string"
      ]
    }
  ],
  "doNotContact": false,
  "education": [
    {
      "current": true,
      "degree": "Master of CSc",
      "endDate": "2015-11-17T18:45:01Z",
      "grade": "string",
      "id": "id-0000002",
      "major": "string",
      "organisationName": "Teradata",
      "program": "string",
      "startDate": "2015-11-17T18:45:00Z"
    }
  ],
  "emails": [
    "[email protected]"
  ],
  "experience": [
    {
      "current": true,
      "description": "Professional Services Consultant with multiple responsabilities",
      "endDate": "2015-11-17T18:45:01Z",
      "id": "id-0000002",
      "organisationName": "Teradata",
      "role": "Professional Services Consultant",
      "startDate": "2015-11-17T18:45:00Z"
    }
  ],
  "firstName": "Bruce",
  "fullName": "Bruce Wayne",
  "gdprConsent": "boolean",
  "gdprConsentDate": "string (date-time)",
  "globalTags": [
    {
      "id": "string",
      "value": "string"
    }
  ],
  "id": "string",
  "integrations": {
    "brassring": {
      "id": "string",
      "url": "string"
    },
    "greenhouse": {
      "email": "string",
      "id": "string",
      "url": "string"
    },
    "jazz": {
      "id": "string"
    },
    "successfactors": {
      "id": "string",
      "url": "string"
    },
    "taleo": {
      "id": "string",
      "url": "string"
    },
    "workday": {
      "id": "string",
      "skills": [
        {
          "id": "string",
          "name": "string"
        }
      ],
      "url": "string"
    }
  },
  "languages": [
    {
      "languageCode": "string",
      "value": "string"
    }
  ]
}
Response Example (400 Bad Request)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}

Delete contact using name of external ATS or system and external user id

DELETE /contact/external/{partnername}/{externalid}

If the contact was migrated from an external ATS or system, you can delete that particular contact by using a combination of the name of the originating ATS or system together with the contact id from that system. Requires the partnername and externalid as parameters.

If the combination of partnername and externalid exists, and the details of that particular contact has been successfully deleted, it returns the HTTP 200 status code. References the Success model and the Error model.

partnername: string
in path

References the name of the originating ATS or system in the Integration model.

externalid: string
in path

The unique contact id of the contact in the originating ATS or system to use to delete their details.

200 OK

the resource was deleted

400 Bad Request

Bad Request

404 Not Found

The specified resource was not found

500 Internal Server Error

Internal server error

Response Example (400 Bad Request)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}

Update contact using name of external ATS or system and external user id

PATCH /contact/external/{partnername}/{externalid}

If the contact was migrated from an external ATS or system, you can update the details of that particular contact by using a combination of the name of the originating ATS or system together with the contact id from that system. Requires the partnername and externalid as parameters.

If the combination of partnername and externalid exists, and the details of that particular contact has been successfully updated, it returns the HTTP 200 status code. The payload will display the values associated with the attributes for that contact. References the Success model and the Error model.

If a request contains values for assignedTo or sourcedBy, the endpoint will check if the specified user id exists. If not, a 400 is returned. If no values are specified these fields default to the id of the user making the request.

The values associate with the contact attributes to update.

partnername: string
in path

References the name of the originating ATS or system in the Integration model.

externalid: string
in path

The unique contact id of the contact in the originating ATS or system to use to update their details.

Request Example
{
  "assignedTo": "8a45c737-f580-4730-b9d1-92dd38502973",
  "confidential": "boolean",
  "confidentiality": {
    "mode": "shares-only",
    "shares": {
      "teams": [
        "string"
      ],
      "users": [
        "string"
      ]
    }
  },
  "createdTime": "string (date-time)",
  "creationSource": {
    "id": "string",
    "value": "string"
  },
  "customFields": [
    {
      "displayName": "string",
      "displayValue": "string",
      "id": "string",
      "name": "string",
      "value": "string",
      "values": [
        "string"
      ],
      "visibleTo": [
        "string"
      ]
    }
  ],
  "doNotContact": false,
  "education": [
    {
      "current": true,
      "degree": "Master of CSc",
      "endDate": "2015-11-17T18:45:01Z",
      "grade": "string",
      "id": "id-0000002",
      "major": "string",
      "organisationName": "Teradata",
      "program": "string",
      "startDate": "2015-11-17T18:45:00Z"
    }
  ],
  "emails": [
    "[email protected]"
  ],
  "experience": [
    {
      "current": true,
      "description": "Professional Services Consultant with multiple responsabilities",
      "endDate": "2015-11-17T18:45:01Z",
      "id": "id-0000002",
      "organisationName": "Teradata",
      "role": "Professional Services Consultant",
      "startDate": "2015-11-17T18:45:00Z"
    }
  ],
  "firstName": "Bruce",
  "fullName": "Bruce Wayne",
  "gdprConsent": "boolean",
  "gdprConsentDate": "string (date-time)",
  "globalTags": [
    {
      "id": "string",
      "value": "string"
    }
  ],
  "id": "string",
  "integrations": {
    "brassring": {
      "id": "string",
      "url": "string"
    },
    "greenhouse": {
      "email": "string",
      "id": "string",
      "url": "string"
    },
    "jazz": {
      "id": "string"
    },
    "successfactors": {
      "id": "string",
      "url": "string"
    },
    "taleo": {
      "id": "string",
      "url": "string"
    },
    "workday": {
      "id": "string",
      "skills": [
        {
          "id": "string",
          "name": "string"
        }
      ],
      "url": "string"
    }
  },
  "languages": [
    {
      "languageCode": "string",
      "value": "string"
    }
  ]
}
200 OK

OK

400 Bad Request

Bad Request

404 Not Found

The specified resource was not found

500 Internal Server Error

Internal server error

Response Example (200 OK)
{
  "assignedTo": "8a45c737-f580-4730-b9d1-92dd38502973",
  "confidential": "boolean",
  "confidentiality": {
    "mode": "shares-only",
    "shares": {
      "teams": [
        "string"
      ],
      "users": [
        "string"
      ]
    }
  },
  "createdTime": "string (date-time)",
  "creationSource": {
    "id": "string",
    "value": "string"
  },
  "customFields": [
    {
      "displayName": "string",
      "displayValue": "string",
      "id": "string",
      "name": "string",
      "value": "string",
      "values": [
        "string"
      ],
      "visibleTo": [
        "string"
      ]
    }
  ],
  "doNotContact": false,
  "education": [
    {
      "current": true,
      "degree": "Master of CSc",
      "endDate": "2015-11-17T18:45:01Z",
      "grade": "string",
      "id": "id-0000002",
      "major": "string",
      "organisationName": "Teradata",
      "program": "string",
      "startDate": "2015-11-17T18:45:00Z"
    }
  ],
  "emails": [
    "[email protected]"
  ],
  "experience": [
    {
      "current": true,
      "description": "Professional Services Consultant with multiple responsabilities",
      "endDate": "2015-11-17T18:45:01Z",
      "id": "id-0000002",
      "organisationName": "Teradata",
      "role": "Professional Services Consultant",
      "startDate": "2015-11-17T18:45:00Z"
    }
  ],
  "firstName": "Bruce",
  "fullName": "Bruce Wayne",
  "gdprConsent": "boolean",
  "gdprConsentDate": "string (date-time)",
  "globalTags": [
    {
      "id": "string",
      "value": "string"
    }
  ],
  "id": "string",
  "integrations": {
    "brassring": {
      "id": "string",
      "url": "string"
    },
    "greenhouse": {
      "email": "string",
      "id": "string",
      "url": "string"
    },
    "jazz": {
      "id": "string"
    },
    "successfactors": {
      "id": "string",
      "url": "string"
    },
    "taleo": {
      "id": "string",
      "url": "string"
    },
    "workday": {
      "id": "string",
      "skills": [
        {
          "id": "string",
          "name": "string"
        }
      ],
      "url": "string"
    }
  },
  "languages": [
    {
      "languageCode": "string",
      "value": "string"
    }
  ]
}
Response Example (400 Bad Request)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}

Share contact details

PUT /contact/{contactId}/confidentiality

Makes the contact's details sharable and restricts who you can share this with. It requires the contactid.

If the contactid exists, and its confidentiality settings have been successfully updated, it returns the HTTP 200 status code and the payload will display the values associated with the attributes you updated earlier. References the Success model and the Error model.

Updates mode to shares-only and the nominated shares (teams or users) in the Confidentiality model. By default, contact details are not shared ( all-confidentials).

contactId: string
in path

References the unique contact id in the Contact model used to retrieve the contact's details.

Request Example
{
  "mode": "shares-only",
  "shares": {
    "teams": [
      "string"
    ],
    "users": [
      "string"
    ]
  }
}

OK

400 Bad Request

Bad Request

403 Forbidden

Forbidden

500 Internal Server Error

Internal server error

Response Example (200 OK)
{
  "mode": "shares-only",
  "shares": {
    "teams": [
      "string"
    ],
    "users": [
      "string"
    ]
  }
}
Response Example (400 Bad Request)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}

Unshare contact details

DELETE /contact/{contactId}/confidentiality

Removes the ability to share the contact's details. It requires the contactid.

If the contactid exists, and its confidentiality settings have been successfully updated, it returns the HTTP 200 status code. It updates all-confidentials and removes all the values for shares (teams and members) in the Confidentiality model. References the Success model and the Error model.

contactId: string
in path

References the unique contact id in the Contact model used to retrieve the contact's details.

200 OK

the resource was deleted

403 Forbidden

Forbidden

500 Internal Server Error

Internal server error

Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}

Updates contact's privacy preferences

POST /contact/{contactId}/contactinfo

Updates the contact's privacy preferences if they've elected not to be included in any existing or future campaigns – the default value is FALSE. It requires the contactid.

If the contactid exists, and their privacy preferences have been successfully updated, it returns the HTTP 200 status code and the payload will display the values associated with the attributes you updated earlier. References the Success model and the Error model.

Updates the value referenced the ContactInfo model.

contactId: string
in path

References the unique contact id in the Contact model used to retrieve the contact's details.

Request Example
{
  "doNotContact": false
}
200 OK

OK

400 Bad Request

Bad Request

404 Not Found

The specified resource was not found

500 Internal Server Error

Internal server error

Response Example (200 OK)
{
  "code": "integer (int32)"
}
Response Example (400 Bad Request)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}

Get contact

GET /contact/{contactid}

Retrieves the details of a particular contact. Requires the contactid as a parameter. If the contactid exists, and the details of that particular contact has been successfully retrieved, it returns the HTTP 200 status code. The payload will display the values associated with the attributes for that contact. References the Success model and the Error model.

Contact collection values, such as those inside experience or education, are not displayed in deterministic order. §

contactid: string
in path

References the unique contact id in the Contact model used to retrieve the contact's details.

200 OK

OK

400 Bad Request

Bad Request

401 Unauthorized

Unauthorized

404 Not Found

The specified resource was not found

500 Internal Server Error

Internal server error

503 Service Unavailable

The requested service is unavailable

default

unexpected error

Response Example (200 OK)
{
  "assignedTo": "8a45c737-f580-4730-b9d1-92dd38502973",
  "confidential": "boolean",
  "confidentiality": {
    "mode": "shares-only",
    "shares": {
      "teams": [
        "string"
      ],
      "users": [
        "string"
      ]
    }
  },
  "createdTime": "string (date-time)",
  "creationSource": {
    "id": "string",
    "value": "string"
  },
  "customFields": [
    {
      "displayName": "string",
      "displayValue": "string",
      "id": "string",
      "name": "string",
      "value": "string",
      "values": [
        "string"
      ],
      "visibleTo": [
        "string"
      ]
    }
  ],
  "doNotContact": false,
  "education": [
    {
      "current": true,
      "degree": "Master of CSc",
      "endDate": "2015-11-17T18:45:01Z",
      "grade": "string",
      "id": "id-0000002",
      "major": "string",
      "organisationName": "Teradata",
      "program": "string",
      "startDate": "2015-11-17T18:45:00Z"
    }
  ],
  "emails": [
    "[email protected]"
  ],
  "experience": [
    {
      "current": true,
      "description": "Professional Services Consultant with multiple responsabilities",
      "endDate": "2015-11-17T18:45:01Z",
      "id": "id-0000002",
      "organisationName": "Teradata",
      "role": "Professional Services Consultant",
      "startDate": "2015-11-17T18:45:00Z"
    }
  ],
  "firstName": "Bruce",
  "fullName": "Bruce Wayne",
  "gdprConsent": "boolean",
  "gdprConsentDate": "string (date-time)",
  "globalTags": [
    {
      "id": "string",
      "value": "string"
    }
  ],
  "id": "string",
  "integrations": {
    "brassring": {
      "id": "string",
      "url": "string"
    },
    "greenhouse": {
      "email": "string",
      "id": "string",
      "url": "string"
    },
    "jazz": {
      "id": "string"
    },
    "successfactors": {
      "id": "string",
      "url": "string"
    },
    "taleo": {
      "id": "string",
      "url": "string"
    },
    "workday": {
      "id": "string",
      "skills": [
        {
          "id": "string",
          "name": "string"
        }
      ],
      "url": "string"
    }
  },
  "languages": [
    {
      "languageCode": "string",
      "value": "string"
    }
  ]
}
Response Example (400 Bad Request)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (503 Service Unavailable)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}

Delete contact

DELETE /contact/{contactid}

Deletes an existing contact. Requires the contactid as a parameter. If the contactid exists, and that particular contact has been successfully deleted, it returns the HTTP 200 status code. References the Success model and the Error model.

contactid: string
in path

The unique identifier of the contact to use to delete their record.

200 OK

the resource was deleted

400 Bad Request

Bad Request

401 Unauthorized

Unauthorized

404 Not Found

The specified resource was not found

500 Internal Server Error

Internal server error

503 Service Unavailable

The requested service is unavailable

default

unexpected error

Response Example (400 Bad Request)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (503 Service Unavailable)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}

Update contact

PATCH /contact/{contactid}

Updates the details of a particular contact. Requires the contactid as a parameter. If the contactid exists, and the details of that particular contact has been successfully updated, it returns the HTTP 200 status code. The payload will display the values associated with the attributes for that contact. References the Success model and the Error model.

If a request contains values for assignedTo or sourcedBy, the endpoint will check if the specified user id exists. If not, a 400 is returned. If no values are specified these fields default to the id of the user making the request.

When including fullName alongside another name field (firstName, middleNames or lastName) in the payload - fullName will be ignored and the other name fields will be used to compute the fullName. If only fullName is provided, the fullName will be set and used to compute the other name fields.

Examples:

Before:  { fullName: "Daniel Craig Bond" }
Payload:
         {
           firstName: "Joao",
           fullName: "Joao Alvarez Ronaldo"
         }
Result:  { fullName: "Joao Craig Bond" }
Before:  { fullName: "Daniel Craig Bond" }
Payload:
         {
           middleNames: ["Jackson"],
           fullName: "Michael Trump Smith"
         }
Result:  { fullName: "Daniel Jackson Bond" }
Before:  { fullName: "Daniel Craig Bond" }
Payload:
         {
           lastName: "Alpine",
           fullName: "Hugo Jackman Wolverine"
         }
Result:  { fullName: "Daniel Craig Alpine" }
Before:  { fullName: "Daniel Craig Bond" }
Payload: { fullName: "Zelda Gold Braveheart" }
Result:  { fullName: "Zelda Gold Braveheart" }

References all the attributes in the Contact model except id which is uniquely generated by the system.

contactid: string
in path

References the unique contact id in the Contact model used to update the contact's details.

Request Example
{
  "assignedTo": "8a45c737-f580-4730-b9d1-92dd38502973",
  "confidential": "boolean",
  "confidentiality": {
    "mode": "shares-only",
    "shares": {
      "teams": [
        "string"
      ],
      "users": [
        "string"
      ]
    }
  },
  "createdTime": "string (date-time)",
  "creationSource": {
    "id": "string",
    "value": "string"
  },
  "customFields": [
    {
      "displayName": "string",
      "displayValue": "string",
      "id": "string",
      "name": "string",
      "value": "string",
      "values": [
        "string"
      ],
      "visibleTo": [
        "string"
      ]
    }
  ],
  "doNotContact": false,
  "education": [
    {
      "current": true,
      "degree": "Master of CSc",
      "endDate": "2015-11-17T18:45:01Z",
      "grade": "string",
      "id": "id-0000002",
      "major": "string",
      "organisationName": "Teradata",
      "program": "string",
      "startDate": "2015-11-17T18:45:00Z"
    }
  ],
  "emails": [
    "[email protected]"
  ],
  "experience": [
    {
      "current": true,
      "description": "Professional Services Consultant with multiple responsabilities",
      "endDate": "2015-11-17T18:45:01Z",
      "id": "id-0000002",
      "organisationName": "Teradata",
      "role": "Professional Services Consultant",
      "startDate": "2015-11-17T18:45:00Z"
    }
  ],
  "firstName": "Bruce",
  "fullName": "Bruce Wayne",
  "gdprConsent": "boolean",
  "gdprConsentDate": "string (date-time)",
  "globalTags": [
    {
      "id": "string",
      "value": "string"
    }
  ],
  "id": "string",
  "integrations": {
    "brassring": {
      "id": "string",
      "url": "string"
    },
    "greenhouse": {
      "email": "string",
      "id": "string",
      "url": "string"
    },
    "jazz": {
      "id": "string"
    },
    "successfactors": {
      "id": "string",
      "url": "string"
    },
    "taleo": {
      "id": "string",
      "url": "string"
    },
    "workday": {
      "id": "string",
      "skills": [
        {
          "id": "string",
          "name": "string"
        }
      ],
      "url": "string"
    }
  },
  "languages": [
    {
      "languageCode": "string",
      "value": "string"
    }
  ]
}
200 OK

OK

400 Bad Request

Bad Request

401 Unauthorized

Unauthorized

404 Not Found

Not found

500 Internal Server Error

Internal server error

503 Service Unavailable

The requested service is unavailable

default

unexpected error

Response Example (200 OK)
{
  "assignedTo": "8a45c737-f580-4730-b9d1-92dd38502973",
  "confidential": "boolean",
  "confidentiality": {
    "mode": "shares-only",
    "shares": {
      "teams": [
        "string"
      ],
      "users": [
        "string"
      ]
    }
  },
  "createdTime": "string (date-time)",
  "creationSource": {
    "id": "string",
    "value": "string"
  },
  "customFields": [
    {
      "displayName": "string",
      "displayValue": "string",
      "id": "string",
      "name": "string",
      "value": "string",
      "values": [
        "string"
      ],
      "visibleTo": [
        "string"
      ]
    }
  ],
  "doNotContact": false,
  "education": [
    {
      "current": true,
      "degree": "Master of CSc",
      "endDate": "2015-11-17T18:45:01Z",
      "grade": "string",
      "id": "id-0000002",
      "major": "string",
      "organisationName": "Teradata",
      "program": "string",
      "startDate": "2015-11-17T18:45:00Z"
    }
  ],
  "emails": [
    "[email protected]"
  ],
  "experience": [
    {
      "current": true,
      "description": "Professional Services Consultant with multiple responsabilities",
      "endDate": "2015-11-17T18:45:01Z",
      "id": "id-0000002",
      "organisationName": "Teradata",
      "role": "Professional Services Consultant",
      "startDate": "2015-11-17T18:45:00Z"
    }
  ],
  "firstName": "Bruce",
  "fullName": "Bruce Wayne",
  "gdprConsent": "boolean",
  "gdprConsentDate": "string (date-time)",
  "globalTags": [
    {
      "id": "string",
      "value": "string"
    }
  ],
  "id": "string",
  "integrations": {
    "brassring": {
      "id": "string",
      "url": "string"
    },
    "greenhouse": {
      "email": "string",
      "id": "string",
      "url": "string"
    },
    "jazz": {
      "id": "string"
    },
    "successfactors": {
      "id": "string",
      "url": "string"
    },
    "taleo": {
      "id": "string",
      "url": "string"
    },
    "workday": {
      "id": "string",
      "skills": [
        {
          "id": "string",
          "name": "string"
        }
      ],
      "url": "string"
    }
  },
  "languages": [
    {
      "languageCode": "string",
      "value": "string"
    }
  ]
}
Response Example (400 Bad Request)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (503 Service Unavailable)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}

Anonymize contact

POST /contact/{contactid}/anonymize

Anonymizes a contact. This behaves like a soft delete, the contact will not be removed from the database, just hidden from future queries.

contactid: string
in path

References the unique contact id in the Contact model used to retrieve the contact's details.

200 OK

OK,

type
object
400 Bad Request

Bad Request

404 Not Found

The specified resource was not found

500 Internal Server Error

Internal server error

Response Example (200 OK)
{
  "message": "string"
}
Response Example (400 Bad Request)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}

De-Anonymize contact

POST /contact/{contactid}/deanonymize

De-Anonymizes a contact.

contactid: string
in path

References the unique contact id in the Contact model used to retrieve the contact's details.

200 OK

OK,

type
object
400 Bad Request

Bad Request

404 Not Found

The specified resource was not found

500 Internal Server Error

Internal server error

Response Example (200 OK)
{
  "message": "string"
}
Response Example (400 Bad Request)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}

Get contact pools

GET /contact/{contactid}/pools

Retrieves all the pools assigned to contactId which the current user is allowed to access.

contactid: string
in path

References the unique contact id in the Contact model used to retrieve the contact's details.

skip: integer
in query

How many items to skip from the results ( to be used for pagination )

limit: integer
in query

How many items will be returned at most.

queryString: string
in query

name to search

200 OK

OK

type
object
400 Bad Request

Bad Request

401 Unauthorized

Unauthorized

404 Not Found

The specified resource was not found

500 Internal Server Error

Internal server error

503 Service Unavailable

The requested service is unavailable

default

unexpected error

Response Example (200 OK)
{
  "metadata": {
    "totalCount": "integer"
  },
  "pools": [
    {
      "customFields": {
        "displayName": "string",
        "displayValue": "string",
        "id": "string",
        "name": "string",
        "value": "string",
        "values": [
          "string"
        ],
        "visibleTo": [
          "string"
        ]
      },
      "date": "2015-11-17T18:45:01Z",
      "id": "string",
      "integrations": {
        "brassring": {
          "id": "string",
          "url": "string"
        },
        "greenhouse": {
          "email": "string",
          "id": "string",
          "url": "string"
        },
        "jazz": {
          "id": "string"
        },
        "successfactors": {
          "id": "string",
          "url": "string"
        },
        "taleo": {
          "id": "string",
          "url": "string"
        },
        "workday": {
          "id": "string",
          "skills": [
            {
              "id": "string",
              "name": "string"
            }
          ],
          "url": "string"
        }
      },
      "owner": "string",
      "poolType": {
        "companyId": "string",
        "createdAt": "string",
        "description": "string",
        "id": "string",
        "name": "string",
        "steps": {
          "sequential": "boolean",
          "values": [
            {
              "id": "string",
              "name": "string"
            }
          ]
        }
      },
      "step": {
        "addedToStepAt": "string (date-time)",
        "id": "string",
        "value": "string"
      },
      "value": "string"
    }
  ]
}
Response Example (400 Bad Request)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (503 Service Unavailable)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}

Get contact vacancies

GET /contact/{contactid}/vacancies

Retrieves all the vacancies assigned to contactId which the current user is allowed to access.

contactid: string
in path

References the unique contact id in the Contact model used to retrieve the contact's details.

skip: integer
in query

How many items to skip from the results ( to be used for pagination )

limit: integer
in query

How many items will be returned at most.

queryString: string
in query

name to search

200 OK

OK

type
object
400 Bad Request

Bad Request

401 Unauthorized

Unauthorized

404 Not Found

The specified resource was not found

500 Internal Server Error

Internal server error

503 Service Unavailable

The requested service is unavailable

default

unexpected error

Response Example (200 OK)
{
  "metadata": {
    "totalCount": "integer"
  },
  "vacancies": [
    {
      "customFields": {
        "displayName": "string",
        "displayValue": "string",
        "id": "string",
        "name": "string",
        "value": "string",
        "values": [
          "string"
        ],
        "visibleTo": [
          "string"
        ]
      },
      "date": "2015-11-17T18:45:01Z",
      "id": "string",
      "integrations": {
        "brassring": {
          "id": "string",
          "url": "string"
        },
        "greenhouse": {
          "email": "string",
          "id": "string",
          "url": "string"
        },
        "jazz": {
          "id": "string"
        },
        "successfactors": {
          "id": "string",
          "url": "string"
        },
        "taleo": {
          "id": "string",
          "url": "string"
        },
        "workday": {
          "id": "string",
          "skills": [
            {
              "id": "string",
              "name": "string"
            }
          ],
          "url": "string"
        }
      },
      "owner": "string",
      "priority": "string",
      "rejectionReason": {
        "date": "2015-11-17T18:45:01Z",
        "id": "string",
        "value": "string"
      },
      "shortPublicId": "string",
      "stage": {
        "date": "2015-11-17T18:45:01Z",
        "group": "string",
        "id": "string",
        "locked": "boolean",
        "value": "string"
      },
      "stages": [
        {
          "assigned": "integer (int32)",
          "contactcount": "integer (int32)",
          "group": "string",
          "id": "string",
          "integrations": {
            "brassring": {
              "id": "string",
              "url": "string"
            },
            "greenhouse": {
              "email": "string",
              "id": "string",
              "url": "string"
            },
            "jazz": {
              "id": "string"
            },
            "successfactors": {
              "id": "string",
              "url": "string"
            },
            "taleo": {
              "id": "string",
              "url": "string"
            },
            "workday": {
              "id": "string",
              "skills": [
                {
                  "id": "string",
                  "name": "string"
                }
              ]
            }
          }
        }
      ]
    }
  ]
}
Response Example (400 Bad Request)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (503 Service Unavailable)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}

Retrieves a list of contacts

GET /contacts

Retrieves a list of contacts. If the list of contacts is successfully retrieved, or if you are using the email filter and it successfully retrieves a single contact, it returns the HTTP 200 status code. The payload will display the values associated with the attributes for that contact. References the Success model and the Error model.

‘Created Date Cursor’ pagination

For iterating over a total list of more than 10,000 results, e.g. when iterating over all contacts in the organisation, this approach is recommended. The approach uses a combination parameters to sequentially retrieve pages of contacts that are determined by the contacts’ createdAt dates:

parameter value
created_at The createdAt time of the last contact in the previous page. For the first page this can be set to an arbitrary date in the distant past
created_at_op 'gte' to ensure that this page has contacts with createdAt dates after those in the previous page
limit The size of each page
sort_field 'createdAt'
sort_order 'asc'

The following is an example of how to implement this approach in JavaScript:

import axios from "axios";
                  
                  const BASE_URL = process.env.BEAMERY_BASE_URL;
                  const BEAMERY_AUTH_TOKEN = process.env.BEAMERY_AUTH_TOKEN;
                  const PAGE_SIZE = 200;
                  
                  const headers = {
                    "Content-Type": "application/json",
                    Authorization: BEAMERY_AUTH_TOKEN,
                  };
                  
                  const getRequestParams = (createdAtFilterValue) => ({
                    sort_field: "createdAt",
                    sort_order: "asc",
                    created_at_op: "gte",
                    created_at: createdAtFilterValue,
                    limit: PAGE_SIZE,
                  });
                  
                  const getPageOfContacts = async (createdAtFilterValue) => {
                    const response = await axios.get(`${BASE_URL}/v1/contacts`, {
                      headers,
                      params: getRequestParams(createdAtFilterValue),
                    });
                    return response.data.contacts;
                  };
                  
                  const getLastContactCreatedAt = (contacts) => {
                    const lastContact = contacts[contacts.length - 1];
                    return lastContact.createdTime;
                  };
                  
                  // ensure we retrieve all contacts by starting from the beginning of time
                  let createdAtFilterValue = new Date(0);
                  
                  while (true) {
                    const contacts = await getPageOfContacts(createdAtFilterValue);
                  
                    // process page of contacts here, allowing for duplicates
                  
                    if (contacts.length < PAGE_SIZE) {
                      break; // finished consuming all contacts
                    }
                    createdAtFilterValue = getLastContactCreatedAt(contacts);
                  }
                  
limit: integer (int32) 0 ≤ x ≤ 200
in query

The number of records to fetch. The maximum and default limit is 200.

⚠️ The offset and limit parameters are unsuitable for iterating over a result set of more than 10,000 contacts. When possible, it is recommended to reduce the size of the result set using time-based filtering parameters. When the result set cannot be filtered, e.g. when iterating over all contacts for the organisation, the ‘Created Date Cursor’ approach detailed above is recommended.

offset: integer (int32) x ≥ 0
in query

Offset is the position you want the recordset to start from. The index starts at 0 (zero). For example, if there are 1,000 records in the database and it is practical to display 25 records per page. If you set:

limit = 25 and offset = 0, it will cause the recordset to start at position 0 and end at position 24 limit = 25 and offset 25, it will cause the recordset to start at position 25 and end at position 49 limit = 25 and offset 50, it will cause the recordset to start at position 50 and and end at position 74

⚠️ The offset and limit parameters are unsuitable for iterating over a result set of more than 10,000 contacts. When possible, it is recommended to reduce the size of the result set using time-based filtering parameters. When the result set cannot be filtered, e.g. when iterating over all contacts for the organisation, the ‘Created Date Cursor’ approach detailed above is recommended.

email: string
in query

Filter to return a single contact matching the contact's email address.

updated_at: string | null
in query

Filter to return contacts updated relative to a provided timestamp. Requires updated_at_op operator.

created_at: string | null
in query

Filter to return contacts created relative to a provided timestamp. Requires created_at_op operator.

created_at_op: string | null eq, neq, lt, lte, gt, gte
in query

Operator for created_at parameter.

updated_at_op: string | null eq, neq, lt, lte, gt, gte
in query

Operator for updated_at parameter.

sort_field: string | null createdAt, updatedAt, id
in query

(no description)

sort_order: string | null asc, desc
in query

(no description)

401 Unauthorized

Unauthorized

500 Internal Server Error

Internal server error

503 Service Unavailable

The requested service is unavailable

default

unexpected error

Response Example (200 OK)
{
  "contacts": [
    {
      "assignedTo": "8a45c737-f580-4730-b9d1-92dd38502973",
      "confidential": "boolean",
      "confidentiality": {
        "mode": "shares-only",
        "shares": {
          "teams": [
            "string"
          ],
          "users": [
            "string"
          ]
        }
      },
      "createdTime": "string (date-time)",
      "creationSource": {
        "id": "string",
        "value": "string"
      },
      "customFields": [
        {
          "displayName": "string",
          "displayValue": "string",
          "id": "string",
          "name": "string",
          "value": "string",
          "values": [
            "string"
          ],
          "visibleTo": [
            "string"
          ]
        }
      ],
      "doNotContact": false,
      "education": [
        {
          "current": true,
          "degree": "Master of CSc",
          "endDate": "2015-11-17T18:45:01Z",
          "grade": "string",
          "id": "id-0000002",
          "major": "string",
          "organisationName": "Teradata",
          "program": "string",
          "startDate": "2015-11-17T18:45:00Z"
        }
      ],
      "emails": [
        "[email protected]"
      ],
      "experience": [
        {
          "current": true,
          "description": "Professional Services Consultant with multiple responsabilities",
          "endDate": "2015-11-17T18:45:01Z",
          "id": "id-0000002",
          "organisationName": "Teradata",
          "role": "Professional Services Consultant",
          "startDate": "2015-11-17T18:45:00Z"
        }
      ],
      "firstName": "Bruce",
      "fullName": "Bruce Wayne",
      "gdprConsent": "boolean",
      "gdprConsentDate": "string (date-time)",
      "globalTags": [
        {
          "id": "string",
          "value": "string"
        }
      ],
      "id": "string",
      "integrations": {
        "brassring": {
          "id": "string",
          "url": "string"
        },
        "greenhouse": {
          "email": "string",
          "id": "string",
          "url": "string"
        },
        "jazz": {
          "id": "string"
        },
        "successfactors": {
          "id": "string",
          "url": "string"
        },
        "taleo": {
          "id": "string",
          "url": "string"
        },
        "workday": {
          "id": "string",
          "skills": [
            {
              "id": "string",
              "name": "string"
            }
          ],
          "url": "string"
        }
      },
      "languages": [
        null
      ]
    }
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (503 Service Unavailable)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}

Retrieves a list of deleted contacts

GET /contacts/deleted

Retrieves a list of 100 deleted contacts for each recordset. Use the parameters to filter the recordset by category, records that have been deleted after a particular date or using a contact id as a reference to fetch the next 100 records.

since: string (date-time)
in query

Only records after this date and time are retrieved.

Use the type parameter in conjunction with this to limit the recordset to a specific category of deleted records. If type isn't specified, the recordset will contain all categories.

afterId: string
in query

Typically, useful only after running this endpoint for the first time as it retrieves the first 100 deleted contact ids. To retrieve the next set of 100 records, use the last contact id as a value for this parameter.

Use the type parameter in conjunction with this to limit the recordset to a specific category of deleted records. If type isn't specified, the recordset will contain all categories.

type: string
in query

The category of the deleted record. Values are:

  • deleted
  • archived
  • anonymised (alias: anonymized)
400 Bad Request

Bad Request

401 Unauthorized

Unauthorized

500 Internal Server Error

Internal server error

Response Example (200 OK)
{
  "ids": [
    "string"
  ],
  "totalCount": "integer"
}
Response Example (400 Bad Request)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}

vacancy

Lets you create, view, update and delete your Beamery platform vacancies. If the vacancy has been migrated across from an external ATS or system, you can flag that record by simply populating an integration attribute which creates a reference to the originating vacancy.

Retrieves a list of vacancies

GET /vacancies

Retrieves a list of existing vacancies, with the option to filter the list.

If the list of vacancies is successfully fetched, it returns an HTTP 200 status code. The payload will display the number of records fetched and the attributes for each of the vacancies in the list. References the Success model and the Error model.

If the total amount of vacancies that you have to retrieve is less or equal to 10,000, you can use the limit and offset param to retrieve them.
If you are retrieving > 10,000 vacancies, you should use our time based filtering and sorting instead.
For instance, you can use these four params (updated_at, updated_at_op, sort_field, and sort_order) or (created_at, created_at_op, sort_field, and sort_order) in your request.
First, you can request all vacancies that were updated/created from T+0.
Then you can request all vacancies that were updated/created from T+1 where T+1 is the updatedTime/createdTime of the last vacancy in the previous batch.
In this way, you can keep iterating until you retrieve all the vacancies in the system.

limit: integer (int32)
in query

The number of records to fetch – the maximum and default limit is 200.
There is a distinct relationship between limit and offset. Together, the values for offset and limit cannot exceed 10,000.
You will get an HTTP 400 error code if this limitation is exceeded.

offset: integer (int32) x ≥ 0
in query

Offset is the position you want the recordset to start from – the index starts at 0 (zero). For example, if there are 1,000 records in the database and it is practical to display 25 records per page. If you set:

limit = 25 and offset = 0, it will cause the recordset to start at position 0 and end at position 24
limit = 25 and offset 25, it will cause the recordset to start at position 25 and end at position 49
limit = 25 and offset 50, it will cause the recordset to start at position 50 and and end at position 74

updated_at: string | null
in query

The date (in ISO-8601 format) the vacancy was last updated.

created_at: string | null
in query

The date (in ISO-8601 format) the vacancy was created.

created_at_op: string | null eq, neq, lt, lte, gt, gte
in query

An enumerated list of operands to apply to the created_at filter. Operands are:
eq (equal)
neq (not equal to)
lt (less than)
lte (less than or equal to)
gt (greater than)
gte (greater than or equal to)

updated_at_op: string | null eq, neq, lt, lte, gt, gte
in query

An enumerated list of operands to apply to the updated_at filter. Operands are:
eq (equal)
neq (not equal to)
lt (less than)
lte (less than or equal to)
gt (greater than)
gte (greater than or equal to)

integration_name: string | null
in query

The name of the integration if the vacancy was migrated from an ATS. References the Integration model.

integration_id: string | null
in query

The id of the integration if the vacancy was migrated from an ATS. References the Integration model.

sort_field: string | null createdAt, updated_at, id
in query

The name of the field to sort by, must be used in combination with sort_order

sort_order: string | null asc, desc
in query

The order of the sorting, must be used in combination with sort_field

200 OK

Ok

400 Bad Request

Bad Request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

500 Internal Server Error

Internal server error

503 Service Unavailable

The requested service is unavailable

504 Gateway Timeout

Timeout

default

unexpected error

Response Example (200 OK)
{
  "totalCount": "integer (int32)",
  "vacancies": [
    {
      "company": "091309mg2oimge4im1f0",
      "contact_count": "integer (int32)",
      "createdAt": "string (date-time)",
      "department": "Lost property",
      "description": "Fantastic position at the canary wharf lost property department",
      "dueDate": "string (date-time)",
      "hash_id": "b24oimg094222",
      "id": "string",
      "integrations": {
        "brassring": {
          "id": "string",
          "url": "string"
        },
        "greenhouse": {
          "email": "string",
          "id": "string",
          "url": "string"
        },
        "jazz": {
          "id": "string"
        },
        "successfactors": {
          "id": "string",
          "url": "string"
        },
        "taleo": {
          "id": "string",
          "url": "string"
        },
        "workday": {
          "id": "string",
          "skills": [
            {
              "id": "string",
              "name": "string"
            }
          ],
          "url": "string"
        }
      },
      "job_level_id": "1",
      "job_url": "string (uri)",
      "location": "Cupboard, Ground Floor, Canary Wharf",
      "manager": "Artemis Fowler",
      "owner": "Ferris Bueller",
      "published": false,
      "salary": "$1000",
      "stages": [
        {
          "assigned": "integer (int32)",
          "contactcount": "integer (int32)",
          "group": "string",
          "id": "string",
          "integrations": {
            "brassring": {
              "id": "string",
              "url": "string"
            },
            "greenhouse": {
              "email": "string",
              "id": "string",
              "url": "string"
            },
            "jazz": {
              "id": "string"
            },
            "successfactors": {
              "id": "string",
              "url": "string"
            },
            "taleo": {
              "id": "string",
              "url": "string"
            },
            "workday": {
              "id": "string",
              "skills": [
                {
                  "id": "string",
                  "name": "string"
                }
              ],
              "url": "string"
            }
          },
          "locked": "boolean",
          "name": "string",
          "order": "integer (int32)",
          "value": "string"
        }
      ],
      "status": "string",
      "team_id": "id-001",
      "title": "Lost property attendant",
      "type": "permanent, part-time, contract",
      "updated_at": "string (date-time)",
      "visibility": "private"
    }
  ]
}
Response Example (400 Bad Request)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (503 Service Unavailable)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (504 Gateway Timeout)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}

Create vacancy

POST /vacancy

Creates a new vacancy. If the new vacancy has been successfully created, it returns the HTTP 200 status code and the payload will display the values associated with the attributes you added earlier. References the Success model and the Error model.

References all the attributes in the Vacancy model except id which is uniquely generated by the system.

Request Example
{
  "company": "091309mg2oimge4im1f0",
  "contact_count": "integer (int32)",
  "createdAt": "string (date-time)",
  "department": "Lost property",
  "description": "Fantastic position at the canary wharf lost property department",
  "dueDate": "string (date-time)",
  "hash_id": "b24oimg094222",
  "id": "string",
  "integrations": {
    "brassring": {
      "id": "string",
      "url": "string"
    },
    "greenhouse": {
      "email": "string",
      "id": "string",
      "url": "string"
    },
    "jazz": {
      "id": "string"
    },
    "successfactors": {
      "id": "string",
      "url": "string"
    },
    "taleo": {
      "id": "string",
      "url": "string"
    },
    "workday": {
      "id": "string",
      "skills": [
        {
          "id": "string",
          "name": "string"
        }
      ],
      "url": "string"
    }
  },
  "job_level_id": "1",
  "job_url": "string (uri)",
  "location": "Cupboard, Ground Floor, Canary Wharf",
  "manager": "Artemis Fowler",
  "owner": "Ferris Bueller",
  "published": false,
  "salary": "$1000",
  "stages": [
    {
      "assigned": "integer (int32)",
      "contactcount": "integer (int32)",
      "group": "string",
      "id": "string",
      "integrations": {
        "brassring": {
          "id": "string",
          "url": "string"
        },
        "greenhouse": {
          "email": "string",
          "id": "string",
          "url": "string"
        },
        "jazz": {
          "id": "string"
        },
        "successfactors": {
          "id": "string",
          "url": "string"
        },
        "taleo": {
          "id": "string",
          "url": "string"
        },
        "workday": {
          "id": "string",
          "skills": [
            {
              "id": "string",
              "name": "string"
            }
          ],
          "url": "string"
        }
      },
      "locked": "boolean",
      "name": "string",
      "order": "integer (int32)",
      "value": "string"
    }
  ],
  "status": "string",
  "team_id": "id-001",
  "title": "Lost property attendant",
  "type": "permanent, part-time, contract",
  "updated_at": "string (date-time)",
  "visibility": "private"
}
200 OK

OK

400 Bad Request

Bad Request

401 Unauthorized

Unauthorized

404 Not Found

The specified resource was not found

500 Internal Server Error

Internal server error

503 Service Unavailable

The requested service is unavailable

504 Gateway Timeout

Timeout

default

unexpected error

Response Example (200 OK)
{
  "company": "091309mg2oimge4im1f0",
  "contact_count": "integer (int32)",
  "createdAt": "string (date-time)",
  "department": "Lost property",
  "description": "Fantastic position at the canary wharf lost property department",
  "dueDate": "string (date-time)",
  "hash_id": "b24oimg094222",
  "id": "string",
  "integrations": {
    "brassring": {
      "id": "string",
      "url": "string"
    },
    "greenhouse": {
      "email": "string",
      "id": "string",
      "url": "string"
    },
    "jazz": {
      "id": "string"
    },
    "successfactors": {
      "id": "string",
      "url": "string"
    },
    "taleo": {
      "id": "string",
      "url": "string"
    },
    "workday": {
      "id": "string",
      "skills": [
        {
          "id": "string",
          "name": "string"
        }
      ],
      "url": "string"
    }
  },
  "job_level_id": "1",
  "job_url": "string (uri)",
  "location": "Cupboard, Ground Floor, Canary Wharf",
  "manager": "Artemis Fowler",
  "owner": "Ferris Bueller",
  "published": false,
  "salary": "$1000",
  "stages": [
    {
      "assigned": "integer (int32)",
      "contactcount": "integer (int32)",
      "group": "string",
      "id": "string",
      "integrations": {
        "brassring": {
          "id": "string",
          "url": "string"
        },
        "greenhouse": {
          "email": "string",
          "id": "string",
          "url": "string"
        },
        "jazz": {
          "id": "string"
        },
        "successfactors": {
          "id": "string",
          "url": "string"
        },
        "taleo": {
          "id": "string",
          "url": "string"
        },
        "workday": {
          "id": "string",
          "skills": [
            {
              "id": "string",
              "name": "string"
            }
          ],
          "url": "string"
        }
      },
      "locked": "boolean",
      "name": "string",
      "order": "integer (int32)",
      "value": "string"
    }
  ],
  "status": "string",
  "team_id": "id-001",
  "title": "Lost property attendant",
  "type": "permanent, part-time, contract",
  "updated_at": "string (date-time)",
  "visibility": "private"
}
Response Example (400 Bad Request)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (503 Service Unavailable)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (504 Gateway Timeout)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}

Get vacancy using name of external ATS or system and external vacancy id

GET /vacancy/external/{partnername}/{externalid}

If the vacancy was migrated from an external ATS or system, you can retrieve the details of that particular vacancy by using a combination of the name of the originating ATS or system together with the vacancy id from that system. Requires the partnername and externalid as parameters.

If the combination of partnername and externalid exists, and the details of that particular contact has been successfully retrieved, it returns the HTTP 200 status code. The payload will display the values associated with the attributes for that vacancy. References the Success model and the Error model.

partnername: string
in path

References the name of the originating ATS or system in the Integration model.

externalid: string
in path

References the unique hash_id in the Vacancy model used to retrieve the vacancy details.

200 OK

OK

400 Bad Request

Bad Request

401 Unauthorized

Unauthorized

404 Not Found

The specified resource was not found

500 Internal Server Error

Internal server error

503 Service Unavailable

The requested service is unavailable

504 Gateway Timeout

Timeout

default

unexpected error

Response Example (200 OK)
{
  "company": "091309mg2oimge4im1f0",
  "contact_count": "integer (int32)",
  "createdAt": "string (date-time)",
  "department": "Lost property",
  "description": "Fantastic position at the canary wharf lost property department",
  "dueDate": "string (date-time)",
  "hash_id": "b24oimg094222",
  "id": "string",
  "integrations": {
    "brassring": {
      "id": "string",
      "url": "string"
    },
    "greenhouse": {
      "email": "string",
      "id": "string",
      "url": "string"
    },
    "jazz": {
      "id": "string"
    },
    "successfactors": {
      "id": "string",
      "url": "string"
    },
    "taleo": {
      "id": "string",
      "url": "string"
    },
    "workday": {
      "id": "string",
      "skills": [
        {
          "id": "string",
          "name": "string"
        }
      ],
      "url": "string"
    }
  },
  "job_level_id": "1",
  "job_url": "string (uri)",
  "location": "Cupboard, Ground Floor, Canary Wharf",
  "manager": "Artemis Fowler",
  "owner": "Ferris Bueller",
  "published": false,
  "salary": "$1000",
  "stages": [
    {
      "assigned": "integer (int32)",
      "contactcount": "integer (int32)",
      "group": "string",
      "id": "string",
      "integrations": {
        "brassring": {
          "id": "string",
          "url": "string"
        },
        "greenhouse": {
          "email": "string",
          "id": "string",
          "url": "string"
        },
        "jazz": {
          "id": "string"
        },
        "successfactors": {
          "id": "string",
          "url": "string"
        },
        "taleo": {
          "id": "string",
          "url": "string"
        },
        "workday": {
          "id": "string",
          "skills": [
            {
              "id": "string",
              "name": "string"
            }
          ],
          "url": "string"
        }
      },
      "locked": "boolean",
      "name": "string",
      "order": "integer (int32)",
      "value": "string"
    }
  ],
  "status": "string",
  "team_id": "id-001",
  "title": "Lost property attendant",
  "type": "permanent, part-time, contract",
  "updated_at": "string (date-time)",
  "visibility": "private"
}
Response Example (400 Bad Request)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (503 Service Unavailable)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (504 Gateway Timeout)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}

Delete vacancy using name of external ATS or system and external vacancy id

DELETE /vacancy/external/{partnername}/{externalid}

If the vacancy was migrated from an external ATS or system, you can delete the details of that particular vacancy by using a combination of the name of the originating ATS or system together with the vacancy id from that system. Requires the partnername and externalid as parameters.

If the combination of partnername and externalid exists, and the details of that particular vacancy has been successfully deleted, it returns the HTTP 200 status code. References the Success model and the Error model.

partnername: string
in path

References the name of the originating ATS or system in the Integration model.

externalid: string
in path

References the unique hash_id in the Vacancy model used to retrieve the vacancy details.

200 OK

the resource was deleted

400 Bad Request

Bad Request

401 Unauthorized

Unauthorized

404 Not Found

The specified resource was not found

500 Internal Server Error

Internal server error

503 Service Unavailable

The requested service is unavailable

504 Gateway Timeout

Timeout

default

unexpected error

Response Example (400 Bad Request)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (503 Service Unavailable)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (504 Gateway Timeout)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}

Update vacancy using name of external ATS or system and external vacancy id

PATCH /vacancy/external/{partnername}/{externalid}

If the vacancy was migrated from an external ATS or system, you can update the details of that particular vacancy by using a combination of the name of the originating ATS or system, the vacancy id from that system and the date and time for this update. Requires the partnername and externalid as parameters.

If the combination of partnername and externalid exists and the value for updated_at is later than the value we currently store for that vacancy, and the details of that particular vacancy have been successfully updated, it returns the HTTP 200 status code. The payload will display the values associated with attributes for that vacancy. References the Success model and the Error model.

Requires updated_at field in request.

References the Vacancy model.

partnername: string
in path

The name of the originating ATS or system. References the Integration model.

externalid: string
in path

References the unique hash_id in the Vacancy model used to retrieve the vacancy details.

Request Example
{
  "company": "091309mg2oimge4im1f0",
  "contact_count": "integer (int32)",
  "createdAt": "string (date-time)",
  "department": "Lost property",
  "description": "Fantastic position at the canary wharf lost property department",
  "dueDate": "string (date-time)",
  "hash_id": "b24oimg094222",
  "id": "string",
  "integrations": {
    "brassring": {
      "id": "string",
      "url": "string"
    },
    "greenhouse": {
      "email": "string",
      "id": "string",
      "url": "string"
    },
    "jazz": {
      "id": "string"
    },
    "successfactors": {
      "id": "string",
      "url": "string"
    },
    "taleo": {
      "id": "string",
      "url": "string"
    },
    "workday": {
      "id": "string",
      "skills": [
        {
          "id": "string",
          "name": "string"
        }
      ],
      "url": "string"
    }
  },
  "job_level_id": "1",
  "job_url": "string (uri)",
  "location": "Cupboard, Ground Floor, Canary Wharf",
  "manager": "Artemis Fowler",
  "owner": "Ferris Bueller",
  "published": false,
  "salary": "$1000",
  "stages": [
    {
      "assigned": "integer (int32)",
      "contactcount": "integer (int32)",
      "group": "string",
      "id": "string",
      "integrations": {
        "brassring": {
          "id": "string",
          "url": "string"
        },
        "greenhouse": {
          "email": "string",
          "id": "string",
          "url": "string"
        },
        "jazz": {
          "id": "string"
        },
        "successfactors": {
          "id": "string",
          "url": "string"
        },
        "taleo": {
          "id": "string",
          "url": "string"
        },
        "workday": {
          "id": "string",
          "skills": [
            {
              "id": "string",
              "name": "string"
            }
          ],
          "url": "string"
        }
      },
      "locked": "boolean",
      "name": "string",
      "order": "integer (int32)",
      "value": "string"
    }
  ],
  "status": "string",
  "team_id": "id-001",
  "title": "Lost property attendant",
  "type": "permanent, part-time, contract",
  "updated_at": "string (date-time)",
  "visibility": "private"
}
200 OK

OK

400 Bad Request

Bad Request

401 Unauthorized

Unauthorized

500 Internal Server Error

Internal server error

503 Service Unavailable

The requested service is unavailable

504 Gateway Timeout

Timeout

default

unexpected error

Response Example (200 OK)
{
  "company": "091309mg2oimge4im1f0",
  "contact_count": "integer (int32)",
  "createdAt": "string (date-time)",
  "department": "Lost property",
  "description": "Fantastic position at the canary wharf lost property department",
  "dueDate": "string (date-time)",
  "hash_id": "b24oimg094222",
  "id": "string",
  "integrations": {
    "brassring": {
      "id": "string",
      "url": "string"
    },
    "greenhouse": {
      "email": "string",
      "id": "string",
      "url": "string"
    },
    "jazz": {
      "id": "string"
    },
    "successfactors": {
      "id": "string",
      "url": "string"
    },
    "taleo": {
      "id": "string",
      "url": "string"
    },
    "workday": {
      "id": "string",
      "skills": [
        {
          "id": "string",
          "name": "string"
        }
      ],
      "url": "string"
    }
  },
  "job_level_id": "1",
  "job_url": "string (uri)",
  "location": "Cupboard, Ground Floor, Canary Wharf",
  "manager": "Artemis Fowler",
  "owner": "Ferris Bueller",
  "published": false,
  "salary": "$1000",
  "stages": [
    {
      "assigned": "integer (int32)",
      "contactcount": "integer (int32)",
      "group": "string",
      "id": "string",
      "integrations": {
        "brassring": {
          "id": "string",
          "url": "string"
        },
        "greenhouse": {
          "email": "string",
          "id": "string",
          "url": "string"
        },
        "jazz": {
          "id": "string"
        },
        "successfactors": {
          "id": "string",
          "url": "string"
        },
        "taleo": {
          "id": "string",
          "url": "string"
        },
        "workday": {
          "id": "string",
          "skills": [
            {
              "id": "string",
              "name": "string"
            }
          ],
          "url": "string"
        }
      },
      "locked": "boolean",
      "name": "string",
      "order": "integer (int32)",
      "value": "string"
    }
  ],
  "status": "string",
  "team_id": "id-001",
  "title": "Lost property attendant",
  "type": "permanent, part-time, contract",
  "updated_at": "string (date-time)",
  "visibility": "private"
}
Response Example (400 Bad Request)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (503 Service Unavailable)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (504 Gateway Timeout)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}

Get vacancy

GET /vacancy/{vacancyid}

Retrieves the details of a particular vacancy. Requires the vacancyid as a parameter. If the vacancyid exists, and the details of that particular vacancy have been successfully retrieved, it returns the HTTP 200 status code. The payload will display the values associated with the attributes for that vacancy. References the Success model and the Error model.

vacancyid: string
in path

References the unique hash_id in the Vacancy model used to retrieve the vacancy details.

Does not currently support id field in Vacancy model.

200 OK

OK

400 Bad Request

Bad Request

401 Unauthorized

Unauthorized

404 Not Found

The specified resource was not found

500 Internal Server Error

Internal server error

503 Service Unavailable

The requested service is unavailable

504 Gateway Timeout

Timeout

default

unexpected error

Response Example (200 OK)
{
  "company": "091309mg2oimge4im1f0",
  "contact_count": "integer (int32)",
  "createdAt": "string (date-time)",
  "department": "Lost property",
  "description": "Fantastic position at the canary wharf lost property department",
  "dueDate": "string (date-time)",
  "hash_id": "b24oimg094222",
  "id": "string",
  "integrations": {
    "brassring": {
      "id": "string",
      "url": "string"
    },
    "greenhouse": {
      "email": "string",
      "id": "string",
      "url": "string"
    },
    "jazz": {
      "id": "string"
    },
    "successfactors": {
      "id": "string",
      "url": "string"
    },
    "taleo": {
      "id": "string",
      "url": "string"
    },
    "workday": {
      "id": "string",
      "skills": [
        {
          "id": "string",
          "name": "string"
        }
      ],
      "url": "string"
    }
  },
  "job_level_id": "1",
  "job_url": "string (uri)",
  "location": "Cupboard, Ground Floor, Canary Wharf",
  "manager": "Artemis Fowler",
  "owner": "Ferris Bueller",
  "published": false,
  "salary": "$1000",
  "stages": [
    {
      "assigned": "integer (int32)",
      "contactcount": "integer (int32)",
      "group": "string",
      "id": "string",
      "integrations": {
        "brassring": {
          "id": "string",
          "url": "string"
        },
        "greenhouse": {
          "email": "string",
          "id": "string",
          "url": "string"
        },
        "jazz": {
          "id": "string"
        },
        "successfactors": {
          "id": "string",
          "url": "string"
        },
        "taleo": {
          "id": "string",
          "url": "string"
        },
        "workday": {
          "id": "string",
          "skills": [
            {
              "id": "string",
              "name": "string"
            }
          ],
          "url": "string"
        }
      },
      "locked": "boolean",
      "name": "string",
      "order": "integer (int32)",
      "value": "string"
    }
  ],
  "status": "string",
  "team_id": "id-001",
  "title": "Lost property attendant",
  "type": "permanent, part-time, contract",
  "updated_at": "string (date-time)",
  "visibility": "private"
}
Response Example (400 Bad Request)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (503 Service Unavailable)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (504 Gateway Timeout)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}

Delete vacancy

DELETE /vacancy/{vacancyid}

Deletes an existing vacancy. Requires the vacancyid as a parameter. If the vacancyid exists, and that particular vacancy has been successfully deleted, it returns the HTTP 200 status code. References the Success model and the Error model.

vacancyid: string
in path

References the unique hash_id in the Vacancy model used to retrieve the vacancy details.

Does not currently support id field in Vacancy model.

200 OK

the resource was deleted

400 Bad Request

Bad Request

401 Unauthorized

Unauthorized

404 Not Found

The specified resource was not found

500 Internal Server Error

Internal server error

503 Service Unavailable

The requested service is unavailable

504 Gateway Timeout

Timeout

default

unexpected error

Response Example (400 Bad Request)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (503 Service Unavailable)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (504 Gateway Timeout)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}

Update vacancy

PATCH /vacancy/{vacancyid}

Updates the details of a particular vacancy. Requires the vacancyid as a parameter. If the vacancyid exists and the value for updated_at is later than the value we currently store for that vacancy, and the details of that particular vacancy have been successfully updated, it returns the HTTP 200 status code. The payload will display the values associated with the attributes for that vacancy. References the Success model and the Error model.

Requires updated_at field in request.

The vacancy to create.

vacancyid: string
in path

References the unique hash_id in the Vacancy model used to retrieve the vacancy details.

Does not currently support id field in Vacancy model.

Request Example
{
  "company": "091309mg2oimge4im1f0",
  "contact_count": "integer (int32)",
  "createdAt": "string (date-time)",
  "department": "Lost property",
  "description": "Fantastic position at the canary wharf lost property department",
  "dueDate": "string (date-time)",
  "hash_id": "b24oimg094222",
  "id": "string",
  "integrations": {
    "brassring": {
      "id": "string",
      "url": "string"
    },
    "greenhouse": {
      "email": "string",
      "id": "string",
      "url": "string"
    },
    "jazz": {
      "id": "string"
    },
    "successfactors": {
      "id": "string",
      "url": "string"
    },
    "taleo": {
      "id": "string",
      "url": "string"
    },
    "workday": {
      "id": "string",
      "skills": [
        {
          "id": "string",
          "name": "string"
        }
      ],
      "url": "string"
    }
  },
  "job_level_id": "1",
  "job_url": "string (uri)",
  "location": "Cupboard, Ground Floor, Canary Wharf",
  "manager": "Artemis Fowler",
  "owner": "Ferris Bueller",
  "published": false,
  "salary": "$1000",
  "stages": [
    {
      "assigned": "integer (int32)",
      "contactcount": "integer (int32)",
      "group": "string",
      "id": "string",
      "integrations": {
        "brassring": {
          "id": "string",
          "url": "string"
        },
        "greenhouse": {
          "email": "string",
          "id": "string",
          "url": "string"
        },
        "jazz": {
          "id": "string"
        },
        "successfactors": {
          "id": "string",
          "url": "string"
        },
        "taleo": {
          "id": "string",
          "url": "string"
        },
        "workday": {
          "id": "string",
          "skills": [
            {
              "id": "string",
              "name": "string"
            }
          ],
          "url": "string"
        }
      },
      "locked": "boolean",
      "name": "string",
      "order": "integer (int32)",
      "value": "string"
    }
  ],
  "status": "string",
  "team_id": "id-001",
  "title": "Lost property attendant",
  "type": "permanent, part-time, contract",
  "updated_at": "string (date-time)",
  "visibility": "private"
}
200 OK

OK

400 Bad Request

Bad Request

401 Unauthorized

Unauthorized

404 Not Found

The specified resource was not found

500 Internal Server Error

Internal server error

503 Service Unavailable

The requested service is unavailable

504 Gateway Timeout

Timeout

default

unexpected error

Response Example (200 OK)
{
  "company": "091309mg2oimge4im1f0",
  "contact_count": "integer (int32)",
  "createdAt": "string (date-time)",
  "department": "Lost property",
  "description": "Fantastic position at the canary wharf lost property department",
  "dueDate": "string (date-time)",
  "hash_id": "b24oimg094222",
  "id": "string",
  "integrations": {
    "brassring": {
      "id": "string",
      "url": "string"
    },
    "greenhouse": {
      "email": "string",
      "id": "string",
      "url": "string"
    },
    "jazz": {
      "id": "string"
    },
    "successfactors": {
      "id": "string",
      "url": "string"
    },
    "taleo": {
      "id": "string",
      "url": "string"
    },
    "workday": {
      "id": "string",
      "skills": [
        {
          "id": "string",
          "name": "string"
        }
      ],
      "url": "string"
    }
  },
  "job_level_id": "1",
  "job_url": "string (uri)",
  "location": "Cupboard, Ground Floor, Canary Wharf",
  "manager": "Artemis Fowler",
  "owner": "Ferris Bueller",
  "published": false,
  "salary": "$1000",
  "stages": [
    {
      "assigned": "integer (int32)",
      "contactcount": "integer (int32)",
      "group": "string",
      "id": "string",
      "integrations": {
        "brassring": {
          "id": "string",
          "url": "string"
        },
        "greenhouse": {
          "email": "string",
          "id": "string",
          "url": "string"
        },
        "jazz": {
          "id": "string"
        },
        "successfactors": {
          "id": "string",
          "url": "string"
        },
        "taleo": {
          "id": "string",
          "url": "string"
        },
        "workday": {
          "id": "string",
          "skills": [
            {
              "id": "string",
              "name": "string"
            }
          ],
          "url": "string"
        }
      },
      "locked": "boolean",
      "name": "string",
      "order": "integer (int32)",
      "value": "string"
    }
  ],
  "status": "string",
  "team_id": "id-001",
  "title": "Lost property attendant",
  "type": "permanent, part-time, contract",
  "updated_at": "string (date-time)",
  "visibility": "private"
}
Response Example (400 Bad Request)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (503 Service Unavailable)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (504 Gateway Timeout)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}

user

Lets you create, view, update and delete your Beamery platform users. If the user has been migrated across from an external ATS or system, you can flag that record by simply populating an integration attribute which creates a reference to the originating user.

Create Beamery user

POST /user

Creates a new Beamery user. If the new Beamery user has been successfully created, it returns the HTTP 200 status code and the payload will display the values associated with the attributes you added earlier. References the Success model and the Error model. A new Beamery user is given the limited user role, by default. A follow-up request to Update user ACL can grant this new user a different user role, and different user permissions.

References all the attributes in the User model.

Request Example
{
  "allowSSO": "boolean",
  "email": "[email protected]",
  "firstName": "Theodore",
  "fromEmails": [
    "[email protected]",
    "[email protected]"
  ],
  "id": "BeameryInternalID_0000",
  "integrations": {
    "brassring": {
      "id": "string",
      "url": "string"
    },
    "greenhouse": {
      "email": "string",
      "id": "string",
      "url": "string"
    },
    "jazz": {
      "id": "string"
    },
    "successfactors": {
      "id": "string",
      "url": "string"
    },
    "taleo": {
      "id": "string",
      "url": "string"
    },
    "workday": {
      "id": "string",
      "skills": [
        {
          "id": "string",
          "name": "string"
        }
      ],
      "url": "string"
    }
  },
  "lastName": "Roosevelt",
  "password": "string",
  "position": "President"
}
200 OK

OK

201 Created

Created

400 Bad Request

Bad Request

401 Unauthorized

Unauthorized

409 Conflict

Conflict

500 Internal Server Error

Internal server error

503 Service Unavailable

The requested service is unavailable

default

unexpected error

Response Example (200 OK)
{
  "allowSSO": "boolean",
  "email": "[email protected]",
  "firstName": "Theodore",
  "fromEmails": [
    "[email protected]",
    "[email protected]"
  ],
  "id": "BeameryInternalID_0000",
  "integrations": {
    "brassring": {
      "id": "string",
      "url": "string"
    },
    "greenhouse": {
      "email": "string",
      "id": "string",
      "url": "string"
    },
    "jazz": {
      "id": "string"
    },
    "successfactors": {
      "id": "string",
      "url": "string"
    },
    "taleo": {
      "id": "string",
      "url": "string"
    },
    "workday": {
      "id": "string",
      "skills": [
        {
          "id": "string",
          "name": "string"
        }
      ],
      "url": "string"
    }
  },
  "lastName": "Roosevelt",
  "password": "string",
  "position": "President"
}
Response Example (400 Bad Request)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (409 Conflict)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (503 Service Unavailable)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}

Get Beamery user using name of external ATS or system and external user id

GET /user/external/{partnername}/{externalid}

If the Beamery user was migrated from an external ATS or system, you can retrieve the details of that particular user with a combination of the name of the originating ATS or system together with the user id from that system. Requires the partnername and externalid as parameters.

If the combination of partnername and externalid exists, and the details of that particular Beamery user has been successfully retrieved, it returns the HTTP 200 status code. The payload will display the values associated with the attributes for that Beamery user. References the Success model and the Error model.

partnername: string
in path

References the name of the originating ATS or system in the Integration model.

externalid: string
in path

References the unique user id in the User model.

200 OK

OK

400 Bad Request

Bad Request

401 Unauthorized

Unauthorized

404 Not Found

User not found

500 Internal Server Error

Internal server error

503 Service Unavailable

The requested service is unavailable

default

unexpected error

Response Example (200 OK)
{
  "allowSSO": "boolean",
  "email": "[email protected]",
  "firstName": "Theodore",
  "fromEmails": [
    "[email protected]",
    "[email protected]"
  ],
  "id": "BeameryInternalID_0000",
  "integrations": {
    "brassring": {
      "id": "string",
      "url": "string"
    },
    "greenhouse": {
      "email": "string",
      "id": "string",
      "url": "string"
    },
    "jazz": {
      "id": "string"
    },
    "successfactors": {
      "id": "string",
      "url": "string"
    },
    "taleo": {
      "id": "string",
      "url": "string"
    },
    "workday": {
      "id": "string",
      "skills": [
        {
          "id": "string",
          "name": "string"
        }
      ],
      "url": "string"
    }
  },
  "lastName": "Roosevelt",
  "password": "string",
  "position": "President"
}
Response Example (400 Bad Request)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (503 Service Unavailable)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}

Update Beamery user using name of external ATS or system and external user id

PUT /user/external/{partnername}/{externalid}

If the Beamery user was migrated from an external ATS or system, you can update the details of that particular user with a combination of the name of the originating ATS or system together with the user id from that system. Requires the partnername and externalid as parameters.

If the combination of partnername and externalid exists, and the details of that particular Beamery user has been successfully updated, it returns the HTTP 200 status code. The payload will display the values associated with the attributes for that Beamery user. References the Success model and the Error model.

Updates the attributes for that user in the Beamer User model.

partnername: string
in path

References the name of the originating ATS or system in the Integration model.

externalid: string
in path

References the unique user id in the User model.

Request Example
{
  "allowSSO": "boolean",
  "email": "[email protected]",
  "firstName": "Theodore",
  "fromEmails": [
    "[email protected]",
    "[email protected]"
  ],
  "id": "BeameryInternalID_0000",
  "integrations": {
    "brassring": {
      "id": "string",
      "url": "string"
    },
    "greenhouse": {
      "email": "string",
      "id": "string",
      "url": "string"
    },
    "jazz": {
      "id": "string"
    },
    "successfactors": {
      "id": "string",
      "url": "string"
    },
    "taleo": {
      "id": "string",
      "url": "string"
    },
    "workday": {
      "id": "string",
      "skills": [
        {
          "id": "string",
          "name": "string"
        }
      ],
      "url": "string"
    }
  },
  "lastName": "Roosevelt",
  "password": "string",
  "position": "President"
}
200 OK

OK

400 Bad Request

Bad Request

401 Unauthorized

Unauthorized

404 Not Found

User not found

500 Internal Server Error

Internal server error

503 Service Unavailable

The requested service is unavailable

default

unexpected error

Response Example (200 OK)
{
  "allowSSO": "boolean",
  "email": "[email protected]",
  "firstName": "Theodore",
  "fromEmails": [
    "[email protected]",
    "[email protected]"
  ],
  "id": "BeameryInternalID_0000",
  "integrations": {
    "brassring": {
      "id": "string",
      "url": "string"
    },
    "greenhouse": {
      "email": "string",
      "id": "string",
      "url": "string"
    },
    "jazz": {
      "id": "string"
    },
    "successfactors": {
      "id": "string",
      "url": "string"
    },
    "taleo": {
      "id": "string",
      "url": "string"
    },
    "workday": {
      "id": "string",
      "skills": [
        {
          "id": "string",
          "name": "string"
        }
      ],
      "url": "string"
    }
  },
  "lastName": "Roosevelt",
  "password": "string",
  "position": "President"
}
Response Example (400 Bad Request)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (503 Service Unavailable)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}

Delete Beamery user using name of external ATS of system and external user id

DELETE /user/external/{partnername}/{externalid}

If the Beamery user was migrated from an external ATS or system, you can delete that particular user with a combination of the name of the originating ATS or system together with the user id from that system. Requires the partnername and externalid as parameters.

If the combination of partnername and externalid exists, and that particular Beamery user has been successfully deleted, it returns the HTTP 200 status code. References the Success model and the Error model.

partnername: string
in path

References the name of the originating ATS or system in the Integration model.

externalid: string
in path

References the unique user id in the User model.

200 OK

the resource was deleted

400 Bad Request

Bad Request

401 Unauthorized

Unauthorized

404 Not Found

User not found

500 Internal Server Error

Internal server error

503 Service Unavailable

The requested service is unavailable

default

unexpected error

Response Example (400 Bad Request)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (503 Service Unavailable)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}

Get Beamery user

GET /user/{userid}

Retrieves the details of a particular Beamery user. Requires the userid as a parameter. If the userid exists, and the details of that particular Beamery user has been successfully retrieved, it returns the HTTP 200 status code. The payload will display the values associated with the attributes for that Beamery user. References the Success model and the Error model.

userid: string
in path

References the unique user id in the User model.

200 OK

OK

400 Bad Request

Bad Request

401 Unauthorized

Unauthorized

404 Not Found

User not found

500 Internal Server Error

Internal server error

503 Service Unavailable

The requested service is unavailable

default

unexpected error

Response Example (200 OK)
{
  "allowSSO": "boolean",
  "email": "[email protected]",
  "firstName": "Theodore",
  "fromEmails": [
    "[email protected]",
    "[email protected]"
  ],
  "id": "BeameryInternalID_0000",
  "integrations": {
    "brassring": {
      "id": "string",
      "url": "string"
    },
    "greenhouse": {
      "email": "string",
      "id": "string",
      "url": "string"
    },
    "jazz": {
      "id": "string"
    },
    "successfactors": {
      "id": "string",
      "url": "string"
    },
    "taleo": {
      "id": "string",
      "url": "string"
    },
    "workday": {
      "id": "string",
      "skills": [
        {
          "id": "string",
          "name": "string"
        }
      ],
      "url": "string"
    }
  },
  "lastName": "Roosevelt",
  "password": "string",
  "position": "President"
}
Response Example (400 Bad Request)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (503 Service Unavailable)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}

Update Beamery user

PUT /user/{userid}

Updates the details of a particular Beamery user. Requires the userid as a parameter. If the userid exists, and the details of that particular Beamery user has been successfully updated, it returns the HTTP 200 status code. The payload will display the values associated with the attributes for that Beamery user. References the Success model and the Error model.

Updates the attributes for that user in the Beamer User model.

userid: string
in path

References the unique user id in the User model.

Request Example
{
  "allowSSO": "boolean",
  "email": "[email protected]",
  "firstName": "Theodore",
  "fromEmails": [
    "[email protected]",
    "[email protected]"
  ],
  "id": "BeameryInternalID_0000",
  "integrations": {
    "brassring": {
      "id": "string",
      "url": "string"
    },
    "greenhouse": {
      "email": "string",
      "id": "string",
      "url": "string"
    },
    "jazz": {
      "id": "string"
    },
    "successfactors": {
      "id": "string",
      "url": "string"
    },
    "taleo": {
      "id": "string",
      "url": "string"
    },
    "workday": {
      "id": "string",
      "skills": [
        {
          "id": "string",
          "name": "string"
        }
      ],
      "url": "string"
    }
  },
  "lastName": "Roosevelt",
  "password": "string",
  "position": "President"
}
200 OK

OK

400 Bad Request

Bad Request

401 Unauthorized

Unauthorized

404 Not Found

User not found

500 Internal Server Error

Internal server error

503 Service Unavailable

The requested service is unavailable

default

unexpected error

Response Example (200 OK)
{
  "allowSSO": "boolean",
  "email": "[email protected]",
  "firstName": "Theodore",
  "fromEmails": [
    "[email protected]",
    "[email protected]"
  ],
  "id": "BeameryInternalID_0000",
  "integrations": {
    "brassring": {
      "id": "string",
      "url": "string"
    },
    "greenhouse": {
      "email": "string",
      "id": "string",
      "url": "string"
    },
    "jazz": {
      "id": "string"
    },
    "successfactors": {
      "id": "string",
      "url": "string"
    },
    "taleo": {
      "id": "string",
      "url": "string"
    },
    "workday": {
      "id": "string",
      "skills": [
        {
          "id": "string",
          "name": "string"
        }
      ],
      "url": "string"
    }
  },
  "lastName": "Roosevelt",
  "password": "string",
  "position": "President"
}
Response Example (400 Bad Request)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (503 Service Unavailable)
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "request_id": "9117aee5-c089-4d0a-b33f-521d49bf912b"
}

Delete Beamery user

DELETE /user/{userid}

Deletes an existing Beamery user. Requires the userid as a parameter. If the userid exists, and that particular Beamery user has been successfully deleted, it returns the HTTP 200 status code. References the Success model and the Error model.

userid: string
in path