# Get Processes

This API endpoint enables fetching a collection of processes. By providing the desired name or programId as parameters, the API response narrows down the results to the specified process.


Endpoint: GET /api/v1/processes
Version: 1.0.0
Security: x-api-key

## Query parameters:

  - `filter[name]` (string)
    Specifies the name of a process. Valid values are strings. Must be used in conjunction with filter[name].
    Example: "Inventory"

  - `filter[programId]` (string)
    Object ID of a program.
    Example: "5e94d5b63f557b001420bbe1"

  - `page[size]` (integer)
    The number of items to return. If not specified, the API will return a default of 30,000 items, which is the maximum value.
    Example: 12000

  - `page[cursor]` (string)
    Pagination cursor that indicates the starting position for the next set of items
    Example: "5e94d5b63f557b001420bbe3"

## Response 200 fields (application/json):

  - `data` (array)
    Array of Processes

  - `data.id` (string)
    Id of process
    Example: "5e94d5b63f557b001420bbe3"

  - `data.name` (string)
    Name of process
    Example: "Inventory"

  - `data.programId` (string)
    Object ID of the program the process is associated with
    Example: "656abc949ec04a00096b56d7"

  - `links` (object)

  - `links.self` (string)
    Link to self
    Example: "/api/v1/processes/items?filter[name]=Inventory&filter[programId]=5e94d5b63f557b001420bbe3&page[size]=50&page[cursor]=5e94d5b63f557b001420bbe3"

  - `links.next` (string)
    Pagination link pointing to the next page
    Example: "/api/v1/processes/items?filter[name]=Inventory&filter[programId]=5e94d5b63f557b001420bbe3&page[size]=50&page[cursor]=63b88f2cb1f05200179e7857"

## Response 400 fields (application/json):

  - `message` (string)
    Reason for the errors related to incorrect query keys or values that are out of bound
    Example: "filter[month] is required"

  - `name` (string)
    BadRequest
    Example: "BadRequest"

  - `status` (integer)
    The HTTP status code.
    Example: 400

## Response 401 fields (application/json):

  - `message` (string)
    Reason for the error such as incorrect service access, malformed, expired or deactivated token.
    Example: "Invalid token"

  - `name` (string)
    Unauthorized
    Example: "Unauthorized"

  - `status` (integer)
    The HTTP status code.
    Example: 401