Process Street API (1.0.0)

Download OpenAPI specification:Download

This API is documented in the OpenAPI format.

The Process Street API is designed around REST. Our API has predictable resource-oriented URLs, returns JSON responses, and uses standard HTTP response codes, HTTP verbs and header based authentication.

The API is meant to be used for ETL/ELT workloads and provides a means for you to extract your data from Process Street.

You must be on the Enterprise plan to use the API. Please contact sales if you are interested in the Enterprise plan.

Authentication

Process Street currently offers a single form of authentication:

API-Key

The API is HTTPS-only and authentication is based on API keys. Each API key is associated with an individual organization in Process Street and can be managed from with the application here. You must be an administrator to manage API keys.

# Example CURL Request

curl --header "X-API-KEY: <api_key>" https://public-api.process.st/checklists
Security Scheme Type API Key
Header parameter name: X-API-KEY

approvals

Retrieves a paginated list of approvals.

An approval task is a special task within a checklist that is used to approve or reject another task. You can learn more about approvals here.

Authorizations:
query Parameters
limit
integer [ 10 .. 500 ]
Default: 10

A limit on the number of objects to be returned.

afterId
string <muid>
Example: afterId=vDKuHI2-1BBciJXpTAhM9A

A cursor used for pagination. afterId is an object ID representing your place in the paginated list. afterId should be omitted in the first call. All subsequent pagination call should should include both afterId and afterUpdatedDate.

afterUpdatedDate
string <date-time>
Example: afterUpdatedDate=2017-07-21T17:32:28.123456Z

A cursor used for pagination. afterUpdatedDate is an RFC date time specified to the microsecond representing your place in the paginated list. afterUpdatedDate can be used on it's own in the first call to define your start position. All subsequent pagination calls should include both afterId and afterUpdatedDate.

Responses

Response samples

Content type
application/json
{
  • "hasMore": true,
  • "nextPageId": "vDKuHI2-1BBciJXpTAhM9A",
  • "nextPageUpdatedDate": "2017-07-21T17:32:28.123456Z",
  • "data": [
    ]
}

assignments

Retrieves a paginated list of assignments.

An assigment is used to assign a user to either a task or checklist. You can learn more about assignments here

Authorizations:
query Parameters
limit
integer [ 10 .. 500 ]
Default: 10

A limit on the number of objects to be returned.

afterId
string <muid>
Example: afterId=vDKuHI2-1BBciJXpTAhM9A

A cursor used for pagination. afterId is an object ID representing your place in the paginated list. afterId should be omitted in the first call. All subsequent pagination call should should include both afterId and afterUpdatedDate.

afterUpdatedDate
string <date-time>
Example: afterUpdatedDate=2017-07-21T17:32:28.123456Z

A cursor used for pagination. afterUpdatedDate is an RFC date time specified to the microsecond representing your place in the paginated list. afterUpdatedDate can be used on it's own in the first call to define your start position. All subsequent pagination calls should include both afterId and afterUpdatedDate.

Responses

Response samples

Content type
application/json
{
  • "hasMore": true,
  • "nextPageId": "vDKuHI2-1BBciJXpTAhM9A",
  • "nextPageUpdatedDate": "2017-07-21T17:32:28.123456Z",
  • "data": [
    ]
}

checklists

Retrieves a paginated list of checklists.

A checklist is an active running instance of a template. A checklist is run from a template which defines what that process is. You can learn more about checklists and templates here.

Authorizations:
query Parameters
limit
integer [ 10 .. 500 ]
Default: 10

A limit on the number of objects to be returned.

afterId
string <muid>
Example: afterId=vDKuHI2-1BBciJXpTAhM9A

A cursor used for pagination. afterId is an object ID representing your place in the paginated list. afterId should be omitted in the first call. All subsequent pagination call should should include both afterId and afterUpdatedDate.

afterUpdatedDate
string <date-time>
Example: afterUpdatedDate=2017-07-21T17:32:28.123456Z

A cursor used for pagination. afterUpdatedDate is an RFC date time specified to the microsecond representing your place in the paginated list. afterUpdatedDate can be used on it's own in the first call to define your start position. All subsequent pagination calls should include both afterId and afterUpdatedDate.

Responses

Response samples

Content type
application/json
{
  • "hasMore": true,
  • "nextPageId": "vDKuHI2-1BBciJXpTAhM9A",
  • "nextPageUpdatedDate": "2017-07-21T17:32:28.123456Z",
  • "data": [
    ]
}

form field values

Retrieves a paginated list of form field values.

A form field value belongs to a specific running checklist and contains the value for a form field on that checklist.

Authorizations:
query Parameters
limit
integer [ 10 .. 500 ]
Default: 10

A limit on the number of objects to be returned.

afterId
string <muid>
Example: afterId=vDKuHI2-1BBciJXpTAhM9A

A cursor used for pagination. afterId is an object ID representing your place in the paginated list. afterId should be omitted in the first call. All subsequent pagination call should should include both afterId and afterUpdatedDate.

afterUpdatedDate
string <date-time>
Example: afterUpdatedDate=2017-07-21T17:32:28.123456Z

A cursor used for pagination. afterUpdatedDate is an RFC date time specified to the microsecond representing your place in the paginated list. afterUpdatedDate can be used on it's own in the first call to define your start position. All subsequent pagination calls should include both afterId and afterUpdatedDate.

Responses

Response samples

Content type
application/json
{
  • "hasMore": true,
  • "nextPageId": "vDKuHI2-1BBciJXpTAhM9A",
  • "nextPageUpdatedDate": "2017-07-21T17:32:28.123456Z",
  • "data": [
    ]
}

form fields

Retrieves a paginated list of form fields.

A form field belongs to a task template and is used when the process the template represents requires some input from the user.

Authorizations:
query Parameters
limit
integer [ 10 .. 500 ]
Default: 10

A limit on the number of objects to be returned.

afterId
string <muid>
Example: afterId=vDKuHI2-1BBciJXpTAhM9A

A cursor used for pagination. afterId is an object ID representing your place in the paginated list. afterId should be omitted in the first call. All subsequent pagination call should should include both afterId and afterUpdatedDate.

afterUpdatedDate
string <date-time>
Example: afterUpdatedDate=2017-07-21T17:32:28.123456Z

A cursor used for pagination. afterUpdatedDate is an RFC date time specified to the microsecond representing your place in the paginated list. afterUpdatedDate can be used on it's own in the first call to define your start position. All subsequent pagination calls should include both afterId and afterUpdatedDate.

Responses

Response samples

Content type
application/json
{
  • "hasMore": true,
  • "nextPageId": "vDKuHI2-1BBciJXpTAhM9A",
  • "nextPageUpdatedDate": "2017-07-21T17:32:28.123456Z",
  • "data": [
    ]
}

tasks

Retrieves a paginated list of tasks.

A task is one step in an active running checklist. A task is defined by its task template which exists on its related template.

Authorizations:
query Parameters
limit
integer [ 10 .. 500 ]
Default: 10

A limit on the number of objects to be returned.

afterId
string <muid>
Example: afterId=vDKuHI2-1BBciJXpTAhM9A

A cursor used for pagination. afterId is an object ID representing your place in the paginated list. afterId should be omitted in the first call. All subsequent pagination call should should include both afterId and afterUpdatedDate.

afterUpdatedDate
string <date-time>
Example: afterUpdatedDate=2017-07-21T17:32:28.123456Z

A cursor used for pagination. afterUpdatedDate is an RFC date time specified to the microsecond representing your place in the paginated list. afterUpdatedDate can be used on it's own in the first call to define your start position. All subsequent pagination calls should include both afterId and afterUpdatedDate.

Responses

Response samples

Content type
application/json
{
  • "hasMore": true,
  • "nextPageId": "vDKuHI2-1BBciJXpTAhM9A",
  • "nextPageUpdatedDate": "2017-07-21T17:32:28.123456Z",
  • "data": [
    ]
}

templates

Retrieves a paginated list of templates.

A template is a list of task templates that lay out exactly how a process should be completed. You can learn more about templates here.

Authorizations:
query Parameters
limit
integer [ 10 .. 500 ]
Default: 10

A limit on the number of objects to be returned.

afterId
string <muid>
Example: afterId=vDKuHI2-1BBciJXpTAhM9A

A cursor used for pagination. afterId is an object ID representing your place in the paginated list. afterId should be omitted in the first call. All subsequent pagination call should should include both afterId and afterUpdatedDate.

afterUpdatedDate
string <date-time>
Example: afterUpdatedDate=2017-07-21T17:32:28.123456Z

A cursor used for pagination. afterUpdatedDate is an RFC date time specified to the microsecond representing