ArchFindrDevelopers
API reference

Requests

The vendor's requests, filterable like the dashboard inbox; a platform key lists all requests

GET
/api/v1/key/requests

The vendor's requests, filterable like the dashboard inbox; a platform key lists all requests.

Requires the requests:read scope.

Authorization

apiKey requests:read
headerAuthorizationBearer <token>

An API key created in the vendor workspace. Send it as Authorization: Bearer afk_....

Scope: requests:read

Query Parameters

q?string
Lengthlength <= 255
page?integer
Range1 <= value
perPage?integer
Range1 <= value <= 100
status?"new"
Value in"new"
type?"info"
Value in"info"
brand?string
unread?boolean

Response Body

Success

application/json
  1. response
data*array<>
metadata*
curl -X GET "https://example.com/api/v1/key/requests"
{  "data": [    {      "provider": {        "id": "string",        "name": "string",        "slug": "string",        "status": "pending",        "logoUrl": "string"      },      "brand": {        "id": "string",        "name": "string",        "slug": "string",        "logoUrl": "string"      },      "createdAt": "string",      "id": "string",      "status": "quoted",      "type": "price",      "updatedAt": "string",      "product": {        "brand": {          "id": "string",          "name": "string",          "slug": "string",          "logoUrl": "string"        },        "compareAtPrice": 0,        "currency": "string",        "hasBim": true,        "id": "string",        "inStock": true,        "isNew": true,        "name": "string",        "price": 0,        "priceOnRequest": true,        "slug": "string",        "type": "string",        "coverUrl": "string",        "hoverUrl": "string"      },      "reference": "string",      "isGuest": true,      "messagesCount": 0,      "subject": "string",      "unread": true,      "contact": {        "name": "string",        "country": "string",        "email": "string",        "profession": "string",        "company": "string"      },      "lastMessage": {        "createdAt": "string",        "excerpt": "string",        "author": "provider"      }    }  ],  "metadata": {    "total": 0,    "perPage": 0,    "currentPage": 0,    "lastPage": 0,    "firstPage": 0,    "firstPageUrl": "string",    "lastPageUrl": "string",    "nextPageUrl": "string",    "previousPageUrl": "string"  }}

One request with its whole thread

GET
/api/v1/key/requests/{id}

One request with its whole thread. Does not mark it read for the team.

Requires the requests:read scope.

Authorization

apiKey requests:read
headerAuthorizationBearer <token>

An API key created in the vendor workspace. Send it as Authorization: Bearer afk_....

Scope: requests:read

Path Parameters

id*string

Response Body

Success

application/json
  1. response
data*
curl -X GET "https://example.com/api/v1/key/requests/string"
{  "data": {    "provider": {      "id": "string",      "name": "string",      "slug": "string",      "status": "pending",      "logoUrl": "string"    },    "brand": {      "id": "string",      "name": "string",      "slug": "string",      "logoUrl": "string"    },    "createdAt": "string",    "id": "string",    "status": "quoted",    "type": "price",    "updatedAt": "string",    "product": {      "brand": {        "id": "string",        "name": "string",        "slug": "string",        "logoUrl": "string"      },      "compareAtPrice": 0,      "currency": "string",      "hasBim": true,      "id": "string",      "inStock": true,      "isNew": true,      "name": "string",      "price": 0,      "priceOnRequest": true,      "slug": "string",      "type": "string",      "coverUrl": "string",      "hoverUrl": "string"    },    "messages": [      {        "createdAt": "string",        "id": "string",        "body": "string",        "attachments": [          {            "name": "string",            "url": "string",            "size": 0          }        ],        "author": "provider",        "authorName": "string"      }    ],    "reference": "string",    "isGuest": true,    "messagesCount": 0,    "subject": "string",    "unread": true,    "contact": {      "name": "string",      "country": "string",      "email": "string",      "profession": "string",      "company": "string"    },    "lastMessage": {      "createdAt": "string",      "excerpt": "string",      "author": "provider"    }  }}

Changes the request status (open, quoted, closed)

PATCH
/api/v1/key/requests/{id}

Changes the request status (open, quoted, closed).

Requires the requests:write scope.

Authorization

apiKey requests:write
headerAuthorizationBearer <token>

An API key created in the vendor workspace. Send it as Authorization: Bearer afk_....

Scope: requests:write

Path Parameters

id*string

Request Body

application/json
  1. body
status*"new"
Value in"new"

Response Body

Success

application/json
  1. response
data*
curl -X PATCH "https://example.com/api/v1/key/requests/string" \  -H "Content-Type: application/json" \  -d '{    "status": "new"  }'
{  "data": {    "provider": {      "id": "string",      "name": "string",      "slug": "string",      "status": "pending",      "logoUrl": "string"    },    "brand": {      "id": "string",      "name": "string",      "slug": "string",      "logoUrl": "string"    },    "createdAt": "string",    "id": "string",    "status": "quoted",    "type": "price",    "updatedAt": "string",    "product": {      "brand": {        "id": "string",        "name": "string",        "slug": "string",        "logoUrl": "string"      },      "compareAtPrice": 0,      "currency": "string",      "hasBim": true,      "id": "string",      "inStock": true,      "isNew": true,      "name": "string",      "price": 0,      "priceOnRequest": true,      "slug": "string",      "type": "string",      "coverUrl": "string",      "hoverUrl": "string"    },    "messages": [      {        "createdAt": "string",        "id": "string",        "body": "string",        "attachments": [          {            "name": "string",            "url": "string",            "size": 0          }        ],        "author": "provider",        "authorName": "string"      }    ],    "reference": "string",    "isGuest": true,    "messagesCount": 0,    "subject": "string",    "unread": true,    "contact": {      "name": "string",      "country": "string",      "email": "string",      "profession": "string",      "company": "string"    },    "lastMessage": {      "createdAt": "string",      "excerpt": "string",      "author": "provider"    }  }}

Replies to the buyer, authored as the key's creator

POST
/api/v1/key/requests/{id}/messages

Replies to the buyer, authored as the key's creator.

Requires the requests:write scope.

Authorization

apiKey requests:write
headerAuthorizationBearer <token>

An API key created in the vendor workspace. Send it as Authorization: Bearer afk_....

Scope: requests:write

Path Parameters

id*string

Request Body

application/json
  1. body
body*string
Length1 <= length <= 5000
attachments?array<>
Lengthlength <= 10

Response Body

Success

application/json
  1. response
data*
curl -X POST "https://example.com/api/v1/key/requests/string/messages" \  -H "Content-Type: application/json" \  -d '{    "body": "string"  }'
{  "data": {    "createdAt": "string",    "id": "string",    "body": "string",    "attachments": [      {        "name": "string",        "url": "string",        "size": 0      }    ],    "author": "provider",    "authorName": "string"  }}

Products

Previous Page

Uploads

Next Page