Skip to main content
POST
/
v1
/
lists
Create a list
curl --request POST \
  --url https://api.metal.ai/v1/lists \
  --header 'Content-Type: application/json' \
  --header 'x-metal-api-key: <api-key>' \
  --header 'x-metal-client-id: <api-key>' \
  --data '
{
  "name": "<string>",
  "resourceType": "company"
}
'
{
  "data": {
    "id": "665f1c2a9b1e4a0012a3b4c5",
    "name": "Q3 sourcing targets",
    "resourceType": "company",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
x-metal-client-id
string
header
required

The Client ID of your API key.

​
x-metal-api-key
string
header
required

The secret value of your API key.

Body

application/json
​
name
string
required

The list's display name.

​
resourceType
string

The type of resource the list holds, e.g. "company".

Example:

"company"

Response

A list.

​
data
object