Projects

Note

Project IDs are returned as strings. job_number, customer, work_site_address and sales_rep can be null, and so can any string field inside them.

Endpoints that take a project ID return 404 when the project doesn’t exist or was deleted, and 403 when it belongs to an organization your token can’t access. Enterprise accounts can access the projects of every company in the enterprise, but Query Projects and Search Projects return only your own company’s projects.

Query Projects

Returns a list of projects in your organization. Projects are returned in sorted order, with the most recently created project appearing first. Archived projects are included, with archived: true.

GET https://api.arcsite.com/v1/projects

cURL

curl "https://api.arcsite.com/v1/projects" \
  -H "Authorization: Bearer your_api_token_here"

JavaScript

const response = await fetch("https://api.arcsite.com/v1/projects", {
  headers: {
    Authorization: "Bearer your_api_token_here",
  },
});
const data = await response.json();

Python

import requests

response = requests.get(
    "https://api.arcsite.com/v1/projects",
    headers={"Authorization": "Bearer your_api_token_here"},
)
data = response.json()

Response

[
  {
    "id": "36029621652695040",
    "name": "project 4",
    "created_at": "2022-01-16T04:19:23.000000Z",
    "updated_at": "2022-01-16T04:19:23.000000Z",
    "job_number": "144111",
    "customer": {
      "name": "Jack",
      "phone": "1441",
      "second_phone": "1122",
      "email": "customer@example.com",
      "second_email": "customer2@example.com",
      "address": {
        "street": "street",
        "city": "city",
        "county": "county",
        "state": "state",
        "zip_code": "300433"
      }
    },
    "work_site_address": {
      "street": "street",
      "city": "city",
      "county": "county",
      "state": "state",
      "zip_code": "300433"
    },
    "sales_rep": {
      "name": "Wang",
      "email": "sales@example.com",
      "phone": "122122-121"
    },
    "tags": ["tag1", "tag2"],
    "archived": false
  }
]

Query Parameters

Parameter	Default	In	Description
page	1	query	Request a specific page
per_page	10	query	Page size (maximum 100)
created_at_begin	None	query	(optional) Only return projects created at or after this time, in UTC ISO 8601 format (e.g., 2025-01-16T04:19:23)
created_at_end	None	query	(optional) Only return projects created at or before this time, in UTC ISO 8601 format (e.g., 2025-01-16T04:19:23)

Note

Send created_at_begin and created_at_end in UTC. A timezone offset in the value is ignored, not converted. A date without a time (e.g., 2025-01-16) means 00:00:00 on that day, so created_at_end=2025-01-16 excludes the rest of January 16.

Create Project

Creates a new project.

POST https://api.arcsite.com/v1/projects

cURL

curl -X POST 'https://api.arcsite.com/v1/projects' \
  -H 'Authorization: Bearer your_api_token_here' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Backyard Fence",
    "owner": "owner@example.com",
    "job_number": "144111",
    "customer": {
      "name": "Jack",
      "phone": "1441",
      "second_phone": "1122",
      "email": "customer@example.com",
      "second_email": "customer2@example.com",
      "address": {
        "street": "street",
        "city": "city",
        "county": "county",
        "state": "state",
        "zip_code": "300433"
      }
    },
    "work_site_address": {
      "street": "street",
      "city": "city",
      "county": "county",
      "state": "state",
      "zip_code": "300433"
    },
    "sales_rep": {
      "name": "Wang",
      "email": "sales@example.com",
      "phone": "122122-121"
    },
    "tags": ["tag1", "tag2"]
  }'

JavaScript

const response = await fetch("https://api.arcsite.com/v1/projects", {
  method: "POST",
  headers: {
    Authorization: "Bearer your_api_token_here",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    name: "Backyard Fence",
    owner: "owner@example.com",
    job_number: "144111",
    customer: {
      name: "Jack",
      phone: "1441",
      second_phone: "1122",
      email: "customer@example.com",
      second_email: "customer2@example.com",
      address: {
        street: "street",
        city: "city",
        county: "county",
        state: "state",
        zip_code: "300433",
      },
    },
    work_site_address: {
      street: "street",
      city: "city",
      county: "county",
      state: "state",
      zip_code: "300433",
    },
    sales_rep: {
      name: "Wang",
      email: "sales@example.com",
      phone: "122122-121",
    },
    tags: ["tag1", "tag2"],
  }),
});
const data = await response.json();

Python

import requests

response = requests.post(
    "https://api.arcsite.com/v1/projects",
    headers={"Authorization": "Bearer your_api_token_here"},
    json={
        "name": "Backyard Fence",
        "owner": "owner@example.com",
        "job_number": "144111",
        "customer": {
            "name": "Jack",
            "phone": "1441",
            "second_phone": "1122",
            "email": "customer@example.com",
            "second_email": "customer2@example.com",
            "address": {
                "street": "street",
                "city": "city",
                "county": "county",
                "state": "state",
                "zip_code": "300433",
            },
        },
        "work_site_address": {
            "street": "street",
            "city": "city",
            "county": "county",
            "state": "state",
            "zip_code": "300433",
        },
        "sales_rep": {
            "name": "Wang",
            "email": "sales@example.com",
            "phone": "122122-121",
        },
        "tags": ["tag1", "tag2"],
    },
)
data = response.json()

Response

{
  "id": "36029621653386360",
  "name": "Backyard Fence",
  "created_at": "2022-01-16T03:31:39.000000Z",
  "updated_at": "2022-01-16T03:31:39.000000Z",
  "job_number": "144111",
  "customer": {
    "name": "Jack",
    "phone": "1441",
    "second_phone": "1122",
    "email": "customer@example.com",
    "second_email": "customer2@example.com",
    "address": {
      "street": "street",
      "city": "city",
      "county": "county",
      "state": "state",
      "zip_code": "300433"
    }
  },
  "work_site_address": {
    "street": "street",
    "city": "city",
    "county": "county",
    "state": "state",
    "zip_code": "300433"
  },
  "sales_rep": {
    "name": "Wang",
    "email": "sales@example.com",
    "phone": "122122-121"
  },
  "tags": ["tag1", "tag2"],
  "archived": false
}

Parameters

Parameter	Type	Description
name	String	(required) Name of the project
owner	String	(required) Owner of the project
customer	Customer	(optional) Customer profile of the project
job_number	String	(optional) Job number of the project
work_site_address	Address	(optional) Worksite address of the project
sales_rep	SalesRep | String	(optional) Sales Representative of the project. Either a SalesRep object, or the email of an active user in your organization, in which case the sales rep’s name, email and phone are taken from that user’s profile.
tags	List[String]	(optional) Tags added to this project

Note

owner is the email, username, or full name (First Last) of a user in your organization (for enterprise accounts, of any company in the enterprise). If no user matches, the request fails with 404.

Note

Tags are case-sensitive. Tags that don’t exist yet are created in your organization. Responses list tags in alphabetical order.

Project Integrations

ArcSite supports integration with various external platforms. Once project creation is complete, you can use the standard integration solutions we provide for different platforms to integrate your project. After integration is completed, your project will gain additional functionality to support data synchronization and interactions with third-party platforms. For specific details, see the integrations module.

Project Name Rules

1. Project name must be unique across the same organization.
2. Project name cannot contain any of the following characters: : / \.
3. Project name cannot start with ..
4. Project name must be less than or equal to 200 characters.

Create Project adjusts a name that breaks rules 2–4 instead of rejecting it: : / \ become spaces, a leading . is removed, the name is cut to 200 characters, and surrounding whitespace is trimmed. Use the name in the response as the stored name. Update Project rejects such a name with 400.

If your organization already has a project with the same name, the request returns 400 Bad Request:

Duplicate name response

{
  "message": "Project name Backyard Fence already exists, please use another name."
}

Other invalid requests, such as a missing required field, also return 400.

Customer

Parameter	Type	Description
name	String	(optional) Customer name
phone	String	(optional) Customer phone
second_phone	String	(optional) Customer secondary phone
email	String	(optional) Customer email. Must be a valid email address
second_email	String	(optional) Customer secondary email. Must be a valid email address
address	Address	(optional) Customer address

Address

Parameter	Type	Description
street	String	(optional) Street name
city	String	(optional) City name
county	String	(optional) County name
state	String	(optional) State name
zip_code	String	(optional) Zip code

SalesRep

Parameter	Type	Description
name	String	(optional) Sales rep name
email	String	(optional) Sales rep email. Must be a valid email address
phone	String	(optional) Sales rep phone

Note

An email field that is present must hold a valid email address: an empty string ("") fails the whole request with 400. To leave an email empty, omit the field or send null.

Update Project

Updates an existing project.

PATCH https://api.arcsite.com/v1/projects/<id>

cURL

curl -X PATCH 'https://api.arcsite.com/v1/projects/<ID>' \
  -H 'Authorization: Bearer your_api_token_here' \
  -H 'Content-Type: application/json' \
  -d '{
    "operator": "admin@example.com",
    "name": "Backyard Fence",
    "job_number": "144111",
    "customer": {
      "name": "Jack",
      "phone": "1441",
      "second_phone": "1122",
      "email": "customer@example.com",
      "second_email": "customer2@example.com",
      "address": {
        "street": "street",
        "city": "city",
        "county": "county",
        "state": "state",
        "zip_code": "300433"
      }
    },
    "work_site_address": {
      "street": "street",
      "city": "city",
      "county": "county",
      "state": "state",
      "zip_code": "300433"
    },
    "sales_rep": {
      "name": "Wang",
      "email": "sales@example.com",
      "phone": "122122-121"
    },
    "tags": ["tag1", "tag2"]
  }'

JavaScript

const response = await fetch("https://api.arcsite.com/v1/projects/<ID>", {
  method: "PATCH",
  headers: {
    Authorization: "Bearer your_api_token_here",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    operator: "admin@example.com",
    name: "Backyard Fence",
    job_number: "144111",
    customer: {
      name: "Jack",
      phone: "1441",
      second_phone: "1122",
      email: "customer@example.com",
      second_email: "customer2@example.com",
      address: {
        street: "street",
        city: "city",
        county: "county",
        state: "state",
        zip_code: "300433",
      },
    },
    work_site_address: {
      street: "street",
      city: "city",
      county: "county",
      state: "state",
      zip_code: "300433",
    },
    sales_rep: {
      name: "Wang",
      email: "sales@example.com",
      phone: "122122-121",
    },
    tags: ["tag1", "tag2"],
  }),
});
const data = await response.json();

Python

import requests

response = requests.patch(
    "https://api.arcsite.com/v1/projects/<ID>",
    headers={"Authorization": "Bearer your_api_token_here"},
    json={
        "operator": "admin@example.com",
        "name": "Backyard Fence",
        "job_number": "144111",
        "customer": {
            "name": "Jack",
            "phone": "1441",
            "second_phone": "1122",
            "email": "customer@example.com",
            "second_email": "customer2@example.com",
            "address": {
                "street": "street",
                "city": "city",
                "county": "county",
                "state": "state",
                "zip_code": "300433",
            },
        },
        "work_site_address": {
            "street": "street",
            "city": "city",
            "county": "county",
            "state": "state",
            "zip_code": "300433",
        },
        "sales_rep": {
            "name": "Wang",
            "email": "sales@example.com",
            "phone": "122122-121",
        },
        "tags": ["tag1", "tag2"],
    },
)
data = response.json()

Parameters

Parameter	Type	Description
operator	String	(required) Who updates the project
name	String	(optional) New name of the project
customer	Customer	(optional) Customer profile of the project
job_number	String	(optional) Job number of the project
work_site_address	Address	(optional) Worksite address of the project
sales_rep	SalesRep | String	(optional) Sales Representative of the project. Same format as in Create Project.
tags	List[String]	(optional) Tags for this project

Note

operator is the email, username, or full name (First Last) of a user in your organization (for enterprise accounts, of any company in the enterprise). If no user matches, the request fails with 404.

Caution

customer, customer.address and work_site_address are replaced as a whole: any sub-field you leave out of an object you send is cleared. To change one field, send the full object. sales_rep is merged instead (sub-fields that are missing or null are left unchanged), and job_number: null is ignored.

Note

If tags is provided, the tags of the project will be replaced by the new provided tags. If the value of tags is set to [], all existing tags on the project will be removed.

The response is the updated project, in the same format as the Create Project response.

Get Project

Returns a project in your organization by project ID.

GET https://api.arcsite.com/v1/projects/<id>

cURL

curl "https://api.arcsite.com/v1/projects/<ID>" \
  -H "Authorization: Bearer your_api_token_here"

JavaScript

const response = await fetch("https://api.arcsite.com/v1/projects/<ID>", {
  headers: {
    Authorization: "Bearer your_api_token_here",
  },
});
const data = await response.json();

Python

import requests

response = requests.get(
    "https://api.arcsite.com/v1/projects/<ID>",
    headers={"Authorization": "Bearer your_api_token_here"},
)
data = response.json()

Response

{
  "id": "36029621652695040",
  "name": "project 4",
  "created_at": "2022-01-16T04:19:23.000000Z",
  "updated_at": "2022-01-16T04:19:23.000000Z",
  "job_number": "144111",
  "customer": {
    "name": "Jack",
    "phone": "1441",
    "second_phone": "1122",
    "email": "customer@example.com",
    "second_email": "customer2@example.com",
    "address": {
      "street": "street",
      "city": "city",
      "county": "county",
      "state": "state",
      "zip_code": "300433"
    }
  },
  "work_site_address": {
    "street": "street",
    "city": "city",
    "county": "county",
    "state": "state",
    "zip_code": "300433"
  },
  "sales_rep": {
    "name": "Wang",
    "email": "sales@example.com",
    "phone": "122122-121"
  },
  "tags": ["tag1", "tag2"],
  "archived": false,
  "owner": "owner@example.com"
}

Search Projects

Searches projects by conditions and returns the list of filtered projects in your organization. Projects are returned in sorted order, with the most recently created project appearing first.

POST https://api.arcsite.com/v1/projects/search

cURL

curl -X POST 'https://api.arcsite.com/v1/projects/search' \
  -H 'Authorization: Bearer your_api_token_here' \
  -H 'Content-Type: application/json' \
  -d '{
    "project_name": "Updated project name",
    "tags": ["Tag 1"]
  }'

JavaScript

const response = await fetch("https://api.arcsite.com/v1/projects/search", {
  method: "POST",
  headers: {
    Authorization: "Bearer your_api_token_here",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    project_name: "Updated project name",
    tags: ["Tag 1"],
  }),
});
const data = await response.json();

Python

import requests

response = requests.post(
    "https://api.arcsite.com/v1/projects/search",
    headers={"Authorization": "Bearer your_api_token_here"},
    json={
        "project_name": "Updated project name",
        "tags": ["Tag 1"],
    },
)
data = response.json()

Response

[
  {
    "id": "36029621652695040",
    "name": "Updated project name",
    "created_at": "2022-01-16T04:19:23.000000Z",
    "updated_at": "2022-01-16T04:19:23.000000Z",
    "job_number": "144111",
    "customer": {
      "name": "Jack",
      "phone": "1441",
      "second_phone": "1122",
      "email": "customer@example.com",
      "second_email": "customer2@example.com",
      "address": {
        "street": "street",
        "city": "city",
        "county": "county",
        "state": "state",
        "zip_code": "300433"
      }
    },
    "work_site_address": {
      "street": "street",
      "city": "city",
      "county": "county",
      "state": "state",
      "zip_code": "300433"
    },
    "sales_rep": {
      "name": "Wang",
      "email": "sales@example.com",
      "phone": "122122-121"
    },
    "tags": ["Tag 1"],
    "archived": false
  }
]

Parameters

Parameter	Type	Description
project_name	String	(optional) Return projects whose name contains this value (case-insensitive)
tags	List[String]	(optional) Return projects that have all of these tags (case-sensitive)
page	Integer	(optional) Page to return, starting at 1. Defaults to 1
per_page	Integer	(optional) Page size. Defaults to 10, maximum 100

Note

When there are multiple tags, only projects that have all of these tags will be returned. For example, if tags are ["Tag 1", "Tag 2"], then the returned projects will all have both Tag 1 and Tag 2. If any of the tags doesn’t exist in your organization, the result is empty.

Get Project Collaborators

Returns everyone who has access to the project — both users added directly and user groups the project is shared with. The owner never appears in this list; their email is available as owner in Get Project. Only active users are listed: users whose account is pending activation or deactivated are omitted.

GET https://api.arcsite.com/v1/projects/<id>/collaborators

cURL

curl "https://api.arcsite.com/v1/projects/<ID>/collaborators" \
  -H "Authorization: Bearer your_api_token_here"

JavaScript

const response = await fetch("https://api.arcsite.com/v1/projects/<ID>/collaborators", {
  headers: {
    Authorization: "Bearer your_api_token_here",
  },
});
const data = await response.json();

Python

import requests

response = requests.get(
    "https://api.arcsite.com/v1/projects/<ID>/collaborators",
    headers={"Authorization": "Bearer your_api_token_here"},
)
data = response.json()

Response

{
  "collaborators": [
    { "type": "user", "email": "admin@example.com", "role": "PROJECT_ADMIN" },
    { "type": "user", "email": "dev@example.com", "role": "PROJECT_COLLABORATOR" },
    {
      "type": "group",
      "group_id": "36029621652695041",
      "name": "Sales Team",
      "role": "PROJECT_VIEWER"
    }
  ]
}

Collaborator Entry

Each entry is either a user or a user group, distinguished by type:

Field	Type	Description
type	String	user or group
email	String	(user only) Email of the collaborator
group_id	String	(group only) Id of the user group, see Get User Group
name	String	(group only) Name of the user group
role	Role	Project role of the user, or of every member of the group. Same values as accepted by Add Project Collaborators.

Note

Groups are not expanded here — a shared group appears as a single group entry. Use Get User Group with the group_id to list its members.

Add Project Collaborators

Adds collaborators to a project. Successfully added collaborators are in the success_items field of the response, and failed items are in fail_items. This API is idempotent, so the same collaborator can be added multiple times. Adding an existing collaborator with a different role adds that role; it doesn’t replace the current one. To lower a collaborator’s role, remove them and add them again.

POST https://api.arcsite.com/v1/projects/<id>/add_collaborators

cURL

curl -X POST 'https://api.arcsite.com/v1/projects/<ID>/add_collaborators' \
  -H 'Authorization: Bearer your_api_token_here' \
  -H 'Content-Type: application/json' \
  -d '{
    "collaborators": [
      { "email": "dev@example.com", "role": "PROJECT_ADMIN" },
      { "email": "unknown@example.com", "role": "PROJECT_ADMIN" }
    ]
  }'

JavaScript

const response = await fetch("https://api.arcsite.com/v1/projects/<ID>/add_collaborators", {
  method: "POST",
  headers: {
    Authorization: "Bearer your_api_token_here",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    collaborators: [
      { email: "dev@example.com", role: "PROJECT_ADMIN" },
      { email: "unknown@example.com", role: "PROJECT_ADMIN" },
    ],
  }),
});
const data = await response.json();

Python

import requests

response = requests.post(
    "https://api.arcsite.com/v1/projects/<ID>/add_collaborators",
    headers={"Authorization": "Bearer your_api_token_here"},
    json={
        "collaborators": [
            {"email": "dev@example.com", "role": "PROJECT_ADMIN"},
            {"email": "unknown@example.com", "role": "PROJECT_ADMIN"},
        ],
    },
)
data = response.json()

Response

{
  "success_items": [
    {
      "email": "dev@example.com",
      "role": "PROJECT_ADMIN"
    }
  ],
  "fail_items": [
    {
      "data": {
        "email": "unknown@example.com",
        "role": "PROJECT_ADMIN"
      },
      "message": "unknown@example.com has not been added to your company account yet."
    }
  ]
}

Parameters

Parameter	Type	Description
collaborators	List[Collaborator]	(required) collaborators to add

Collaborator

Parameter	Type	Description
email	String	(required) Email of the collaborator. Must be a valid email address; an invalid value fails the whole request with 400
role	Role	(required) Project role

Role

1. PROJECT_ADMIN — Project admins have full access to the project.
2. PROJECT_COLLABORATOR — Can create, edit, and delete drawings. This role cannot delete the project or manage collaborators.
3. PROJECT_VIEWER — Project viewers can only view drawings.

Note

The collaborator’s ArcSite account must be created and added to your organization before they can be added as a project collaborator.

Remove Project Collaborators

Removes collaborators from a project.

POST https://api.arcsite.com/v1/projects/<id>/remove_collaborators

cURL

curl -X POST 'https://api.arcsite.com/v1/projects/<ID>/remove_collaborators' \
  -H 'Authorization: Bearer your_api_token_here' \
  -H 'Content-Type: application/json' \
  -d '{
    "emails": [
      "dev@example.com",
      "unknown@example.com"
    ]
  }'

JavaScript

const response = await fetch("https://api.arcsite.com/v1/projects/<ID>/remove_collaborators", {
  method: "POST",
  headers: {
    Authorization: "Bearer your_api_token_here",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    emails: ["dev@example.com", "unknown@example.com"],
  }),
});
const data = await response.json();

Python

import requests

response = requests.post(
    "https://api.arcsite.com/v1/projects/<ID>/remove_collaborators",
    headers={"Authorization": "Bearer your_api_token_here"},
    json={
        "emails": ["dev@example.com", "unknown@example.com"],
    },
)
data = response.json()

Parameters

Parameter	Type	Description
emails	List[String]	(required) emails to remove

Response

{}

Emails that aren’t collaborators on the project are ignored. User groups shared with the project can’t be removed with this endpoint.

Get User Group

Returns a user group of your organization with its members. Use the group_id from Get Project Collaborators to expand a shared group into individual users.

GET https://api.arcsite.com/v1/user_groups/<id>

cURL

curl "https://api.arcsite.com/v1/user_groups/<ID>" \
  -H "Authorization: Bearer your_api_token_here"

JavaScript

const response = await fetch("https://api.arcsite.com/v1/user_groups/<ID>", {
  headers: {
    Authorization: "Bearer your_api_token_here",
  },
});
const data = await response.json();

Python

import requests

response = requests.get(
    "https://api.arcsite.com/v1/user_groups/<ID>",
    headers={"Authorization": "Bearer your_api_token_here"},
)
data = response.json()

Response

{
  "id": "36029621652695041",
  "name": "Sales Team",
  "members": [
    {
      "user_id": "36029621652695042",
      "name": "Bob Smith",
      "email": "bob@example.com"
    },
    {
      "user_id": "36029621652695043",
      "name": "Jane Doe",
      "email": "jane@example.com"
    }
  ]
}

Member

Field	Type	Description
user_id	String	Id of the user
name	String	Full name of the user
email	String	Email of the user

Only active users are listed as members.

Get Project Drawings

Returns the drawings of a project, newest first.

GET https://api.arcsite.com/v1/projects/<id>/drawings

cURL

curl "https://api.arcsite.com/v1/projects/<ID>/drawings" \
  -H "Authorization: Bearer your_api_token_here"

JavaScript

const response = await fetch("https://api.arcsite.com/v1/projects/<ID>/drawings", {
  headers: {
    Authorization: "Bearer your_api_token_here",
  },
});
const data = await response.json();

Python

import requests

response = requests.get(
    "https://api.arcsite.com/v1/projects/<ID>/drawings",
    headers={"Authorization": "Bearer your_api_token_here"},
)
data = response.json()

Response

[
  {
    "id": "36029621653385418",
    "name": "drawing 1"
  },
  {
    "id": "36029621653385407",
    "name": "drawing 2"
  }
]

Query Parameters

Parameter	Default	In	Description
page	1	query	Request a specific page
per_page	10	query	Page size (maximum 100)

Import PDF

Your uploaded PDF will be split into multiple pages; one ArcSite drawing is created for each page.

POST https://api.arcsite.com/v1/projects/<id>/import_pdf

cURL

# upload a local file
curl --location 'https://api.arcsite.com/v1/projects/<ID>/import_pdf' \
  -H "Authorization: Bearer your_api_token_here" \
  --form 'file=@"/<file_path>/<file_name.pdf>"'

# or pass the file url directly
curl --location 'https://api.arcsite.com/v1/projects/<ID>/import_pdf' \
  -H "Authorization: Bearer your_api_token_here" \
  --form 'file_url="https://example.com/plan.pdf"'

JavaScript

// upload a local file
const form = new FormData();
form.append("file", fileInput.files[0]);

// or pass a file URL directly:
// form.append("file_url", "https://example.com/plan.pdf");

const response = await fetch("https://api.arcsite.com/v1/projects/<ID>/import_pdf", {
  method: "POST",
  headers: {
    Authorization: "Bearer your_api_token_here",
  },
  body: form,
});
const data = await response.json();

Python

import requests

# upload a local file
with open("/path/to/file.pdf", "rb") as f:
    response = requests.post(
        "https://api.arcsite.com/v1/projects/<ID>/import_pdf",
        headers={"Authorization": "Bearer your_api_token_here"},
        files={"file": f},
    )

# or pass a file URL directly (still sent as multipart/form-data):
# response = requests.post(
#     "https://api.arcsite.com/v1/projects/<ID>/import_pdf",
#     headers={"Authorization": "Bearer your_api_token_here"},
#     files={"file_url": (None, "https://example.com/plan.pdf")},
# )
data = response.json()

Response

{
  "drawings": [
    {
      "id": "36029621653385418"
    },
    {
      "id": "36029621653385407"
    }
  ]
}

Request Payload

Parameter	In	Description
file	Body	The binary PDF file to be uploaded
file_url	Body	The URL of a publicly accessible PDF file

Note

Request content type must be multipart/form-data to upload a PDF file, also when you send file_url. Either file or file_url must be provided, but not both.

file_url must be an https URL on the public internet that returns the PDF directly: redirects and credentials in the URL aren’t allowed, the file can be at most 100 MB, and the server must respond within 20 seconds.

The request is processed synchronously, so it can take a while for large PDFs. A page that fails to process is skipped, so drawings can have fewer entries than the PDF has pages.

Errors: 400 when file and file_url are both missing or both present, when the URL can’t be downloaded, or when the file isn’t a valid PDF (including corrupted and password-protected files). 403 when your organization has reached its limit of drawings created from PDF files.

Archive Project

Archives a project by project ID. The archived project will be hidden from the project list in the ArcSite apps. Query Projects and Search Projects still return it, with archived: true. You can use Unarchive Project to unarchive it.

POST https://api.arcsite.com/v1/projects/<ID>/archive

cURL

curl -X POST 'https://api.arcsite.com/v1/projects/<ID>/archive' \
  -H 'Authorization: Bearer your_api_token_here' \
  -H 'Content-Type: application/json'

JavaScript

const response = await fetch("https://api.arcsite.com/v1/projects/<ID>/archive", {
  method: "POST",
  headers: {
    Authorization: "Bearer your_api_token_here",
  },
});
const data = await response.json();

Python

import requests

response = requests.post(
    "https://api.arcsite.com/v1/projects/<ID>/archive",
    headers={"Authorization": "Bearer your_api_token_here"},
)
data = response.json()

Response

{}

Unarchive Project

Unarchives a project by project ID.

POST https://api.arcsite.com/v1/projects/<ID>/unarchive

cURL

curl -X POST 'https://api.arcsite.com/v1/projects/<ID>/unarchive' \
  -H 'Authorization: Bearer your_api_token_here' \
  -H 'Content-Type: application/json'

JavaScript

const response = await fetch("https://api.arcsite.com/v1/projects/<ID>/unarchive", {
  method: "POST",
  headers: {
    Authorization: "Bearer your_api_token_here",
  },
});
const data = await response.json();

Python

import requests

response = requests.post(
    "https://api.arcsite.com/v1/projects/<ID>/unarchive",
    headers={"Authorization": "Bearer your_api_token_here"},
)
data = response.json()

Response

{}

Transfer Project Owner

Transfers ownership of a project to another user. The new owner must belong to the same organization.

POST https://api.arcsite.com/v1/projects/<ID>/transfer_owner

cURL

curl -X POST 'https://api.arcsite.com/v1/projects/<ID>/transfer_owner' \
  -H 'Authorization: Bearer your_api_token_here' \
  -H 'Content-Type: application/json' \
  -d '{
    "owner": "newowner@example.com"
  }'

JavaScript

const response = await fetch("https://api.arcsite.com/v1/projects/<ID>/transfer_owner", {
  method: "POST",
  headers: {
    Authorization: "Bearer your_api_token_here",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    owner: "newowner@example.com",
  }),
});
const data = await response.json();

Python

import requests

response = requests.post(
    "https://api.arcsite.com/v1/projects/<ID>/transfer_owner",
    headers={"Authorization": "Bearer your_api_token_here"},
    json={
        "owner": "newowner@example.com",
    },
)
data = response.json()

Response

{}

Parameters

Parameter	Type	Description
owner	String	(required) Email or full name (first name + last name) of new owner

Note

owner must be an active ArcSite user that belongs to the same organization (not another company of your enterprise). The value can be the user’s email address or full name (exactly a first and a last name, e.g. Jane Doe).

Errors: 404 if no active user in your organization matches owner, and 400 if the user already owns the project or the project can’t be transferred.