Skip to main content
GET
/
procedures
Get Procedures
curl --request GET \
  --url https://api.proced.ai/procedures \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "cm0upgshc000rwf5eop1u2awr",
      "name": "Proced AI title",
      "priority": "MEDIUM",
      "state": "TODO",
      "creatorId": "cm2uj5ffn001x7xtag73jmpx0",
      "position": 1,
      "dueAt": "2024-09-22T22:00:00.000Z",
      "createdAt": "2024-09-22T22:00:00.000Z",
      "updatedAt": "2024-09-22T22:00:00.000Z",
      "projectId": "cm2uj5ffn001x7xtag73jmpx0",
      "workspaceId": "cm2uj5ffn001x7xtag73jmpx0",
      "displayVideo": true,
      "isFineTunedData": false,
      "shortId": "cm0upgshc000rwf5eop1u2awr",
      "content": "Procedure content goes here.",
      "categoryId": "cm2uqwcpd002s7xta3b1j8q3p",
      "doerId": "cm2uj5ffn001x7xtag73jmpx0",
      "captureId": "cm2uqwcpd002s7xta3b1j8q3p",
      "category": {
        "id": "<string>",
        "name": "<string>"
      },
      "doer": {
        "id": "<string>",
        "name": "<string>",
        "email": "<string>"
      },
      "project": {
        "id": "<string>",
        "name": "<string>"
      },
      "comments": [
        {
          "id": "<string>",
          "text": "<string>",
          "createdAt": "<string>"
        }
      ]
    }
  ],
  "meta": {
    "total": 50
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

q
string

Search query

Example:

"Proced AI create procedure"

size
string

Size by page

Example:

"50"

page
string

Page for pagination results

Example:

"1"

sortBy
enum<string>

Sort by

Available options:
createdAt,
dueAt,
project.name,
name
Example:

"dueAt"

categoryId
string

filter by categoryId

Example:

"cm2uqwcpd002s7xta3b1j8q3p"

doerId
string

filter by doerId

Example:

"cm2uqwcpd002s7xta3b1j8q3p"

startedAt
string

startedAt filter by started date

Example:

"2023-03-15T00:00:00.000Z"

dueAt
string

dueAt filter by ended date

Example:

"2023-03-15T00:00:00.000Z"

Response

Retrieve procedures

data
object[]
required
meta
object
required