/api/v1/action/{action_id}/contact-details

GET

const url = 'https://dpg.example.com/api/v1/action/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/contact-details';
const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://dpg.example.com/api/v1/action/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/contact-details \
  --header 'x-api-key: <x-api-key>'

Authorizations

apiKeyAuth
sessionAuth

Parameters

Path Parameters

action_id

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Header Parameters

x-acting-org-id

string

Organization this request acts on behalf of. Optional: a non-admin actor can perform an action without acting for an org.

Responses

200

Default Response

application/json

object

action_id

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

action_status

required

string

>= 1 characters

other_actor

required

object

item

required

object

item_network

required

string

item_domain

required

string

item_type

required

string

item_id

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

item_instance_url

required

string

item_schema_url

required

string

item_state

required

Any of:

string

item_locations

required

Array<object>

object

lat

required

number

>= -90 <= 90

lng

required

number

>= -180 <= 180

label

string

created_by

required

string

created_at

required

string format: date-time

updated_at

required

string format: date-time

lifecycle_status

string

Allowed values: draft live paused

Example

{
  "other_actor": {
    "item": {
      "item_state": null,
      "lifecycle_status": "draft"
    }
  }
}