BIbindbee
Attachment

Get Attachment By Id

Changed on

Returns an Attachment object with the given id.

get/api/ats/v1/attachments/{id}

Request

  • Base URL
    https://api.bindbee.dev (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer and API key in header X-Connector-Token

Path parameters

idstring uuid required

Query parameters

include_raw_databoolean

Whether to include the original data Bindbee fetched from the third-party to produce these models.

include_custom_fieldsboolean

Whether to include custom fields in the response.

expandstring nullable

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name. Add .custom_fields to return an expanded record's custom fields, or .custom_fields[name,other_name] for only those (quote a name holding anything but letters, digits, _ and -: .custom_fields["wd:Visa_ID"]).

Example:manager[first_name,last_name]

Response

Successful Response

file_namestring nullable

The name of the file attached.

attachment_typestring nullable

The type of attachment. If the value is not one of the defined enum values, the original value passed through will be returned.

idstring uuid required
remote_idstring nullable required

The third-party API ID of the matching object.

modified_atstring date-time required

This is the datetime that this object was last updated by Bindbee

raw_dataobject nullable

This is the Raw data

custom_fieldsobject nullable required

The custom fields related to the model

file_urlstring nullable

The URL where the file is stored and can be retrieved.

candidatestring nullable

The candidate to whom the attachment belongs.

Example response

{
  "file_name": "resume.pdf",
  "attachment_type": "RESUME",
  "id": "018b18ef-c487-703c-afd9-0ca478ccd9d6",
  "remote_id": "123321",
  "modified_at": "2021-10-16T00:00:00Z",
  "raw_data": {
    "key_1": "Platform dependent data 1",
    "key_2": "Platform dependent data 2"
  },
  "custom_fields": {
    "category_group": "REG",
    "disability_type": "ASBERG",
    "hire_date": "1991-03-16T00:00:00",
    "hire_source": "REFER",
    "nationality": "USA",
    "original_hire_date": "1991-03-16T00:00:00"
  },
  "file_url": "https://example.com/path/to/resume.pdf",
  "candidate": "018b4bfb-5ece-70b1-ad5e-862a9433aa65"
}

Changes

  • 1f9bc0ad4bfbRevision changes
    • breaking

      the / response property's maxLength was unset from 2083 for the response status

    • breaking

      the / response property's minLength was decreased from 1 to 0 for the response status

    • breaking

      the / response's property format changed from uri to no format for status

    • info

      the endpoint scheme security HTTPBearer AND ConnectorToken was added to the API

    • info

      the endpoint scheme security ConnectorToken was removed from the API

    • info

      the endpoint scheme security HTTPBearer was removed from the API

    • info

      removed the - enum value from the response property for the response status

    • info

      removed the COVER_LETTER enum value from the response property for the response status

    • info

      removed the OFFER_LETTER enum value from the response property for the response status

    • info

      removed the OTHER enum value from the response property for the response status

    • info

      removed the RESUME enum value from the response property for the response status

  • cf8209fb1cd7Revision changes
    • warning

      deleted the header request parameter x-connector-token

    • info

      the endpoint scheme security ConnectorToken was added to the API