Get the prospect interaction types

GET /api/members/prospects/interaction-types

Success: 200 OK

Products: not restricted by product
Features: Prospecting (PROSPECTS)

Overview

Returns the interaction types you can record against a prospect. A prospect is a sales lead — someone being followed up as a potential joiner — held as a member record and identified by a member id like any other member. An interaction is a logged contact with that lead: a call, a task or an appointment.

This is the first of three lookups you call before recording an interaction with POST /api/members/prospects/{memberId}/interactions. Take the id of the type you want from this response, then pass it as the {type} path segment to GET /api/members/prospects/interaction-subtypes/{type} and GET /api/members/prospects/interaction-outcomes/{type}. Neither of those endpoints, nor the create call, accepts anything other than an id that originated here.

You never send the type id to the create call itself. That call takes an interactionSubTypeId and an outcomeOfInteractionTypeId, and derives the type from the sub type — so this lookup exists to narrow the sub type and outcome lists, not to be posted back. It rejects a sub type or outcome it does not recognise with a 422.

The types are configuration data held in your Gladstone system, not a fixed list built into the API: only types flagged active are returned, and they are ordered by description. Read the list once and cache it rather than calling it per interaction, and do not hard-code the ids.

Do not confuse the string id returned here with the interactionType integer that the interaction endpoints return on an interaction record (0 call, 1 task, 2 appointment). They are different values and are not interchangeable.

Endpoint

GET {base_url}/api/members/prospects/interaction-types

{base_url} is the environment URL issued to your integration. See Authenticating with Gladstone APIs.

Sample request

cURL

curl -X GET '{base_url}/api/members/prospects/interaction-types' \
  -H 'Authorization: Bearer {accessToken}' \
  -H 'X-Use-SSO: true'

Response fields

Field	Type	Description
`[].id`	string	The identifier of the interaction type, and the value you pass as the `{type}` path segment to the sub types and outcomes lookups. A short configured string, not a number.
`[].description`	string	The type's name as configured on the system — the wording behind call, task and appointment. Results are ordered by this field. Show `translations` instead when you know the reader's language.
`[].translations`	array of object	The type's text translated into each culture configured on the system. Returned as an empty array, never null, when no translations are held for the type.
`[].translations[].type`	string	The record type the translation belongs to. Only translations of this interaction type are returned, so every entry here relates to the type it is nested under.
`[].translations[].culture`	string	The culture the `text` belongs to, used to pick the variant matching your user's language.
`[].translations[].text`	string	The translated text for this culture. Display this in place of `description` when you hold a translation for the culture you are rendering in.

Sample response

200 OK

[
  {
    "id": "string",
    "description": "string",
    "translations": [
      {
        "type": "string",
        "culture": "string",
        "text": "string"
      }
    ]
  }
]

Errors

Status	Meaning	When
`500`	Internal server error

This page as markdown · All pages · llms.txt