Projects

Create a project

Creates a project with the specified configuration. Note that flows can also be attached to the project later by calling endpoints to update the project.

post/projects

Request

Request body

namestring required
descriptionstring

Example request

{
  "name": "test project",
  "description": "it's a test project"
}

Response

Success

idinteger

Unique identifier of this project.

namestring
descriptionstring
access_rolesstring[]

This property reflects all the permissions the user/team/organization has to this resource.

  1. collaborator: The user/team/organization can view the resource but not make any modifications to it.
  2. operator: The user/team/organization can view the resource and can activate/pause it, but not make any other modifications to it.
  3. administrator: The user/team/organization has complete administrative rights to this resource.
  4. owner: This user created the resource and so has complete administrative rights to it.
tagsstring[]
copied_from_idstring nullable
updated_atstring date-time
created_atstring date-time

Example response

{
  "owner": {
    "full_name": "John Johnson",
    "email": "example@nexla.com"
  },
  "org": {
    "name": "Nexla",
    "email_domain": "nexla.com"
  },
  "name": "test project",
  "description": "it's a test project",
  "data_flows": [
    {
      "updated_at": "2023-01-31T01:39:54.000Z",
      "created_at": "2023-01-31T01:39:54.000Z"
    }
  ],
  "flows": [
    {
      "updated_at": "2023-01-31T01:39:54.000Z",
      "created_at": "2023-01-31T01:39:54.000Z"
    }
  ],
  "updated_at": "2023-01-31T01:39:54.000Z",
  "created_at": "2023-01-31T01:39:54.000Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.