{"info":{"_postman_id":"f3effbb7-d678-47b0-8b9c-6f7fca3d9f76","name":"Prysmex API Documentation","description":"

\n\n

🎉 Welcome to the Prysmex API Documentation! `v8.4.11`

Explore and interact with nearly every feature available in the Prysmex app — all through powerful API calls.

Setup

👤 Create a Prysmex account

Before you can use our APIs, you'll need an API-KEY🔑. If you already have an account, login to you account or create a new account.

📁 Create a space

Now that you've created you account, you need to create a Space to generate an ApiKey.

\n
A space represents a client within the platform and can be associated with a plan. All Prysmex modules and features are located within a space, and only users (except managed users) can move between spaces.
\n

For help creating a space, please refer to https://help.prysmex.com

🔑 Generate an API KEY

Now that you are inside a space, navigate to settings > api keys to generate a your ApiKey.

\n
API-KEYs impersonate users, if you would like to limit the api key privileges, create a user with a role that has the privileges you require for your use case.
\n

After generating the ApiKey, make sure you store it safely since it cannot be recovered after creation.

Now lets configure lets import and configure the collection to start using the APIs! 🚀

↓ Import the collection

Click \"Run in Postman\" to get started!

If you don’t have a Postman account yet, you’ll be prompted to create one — it’s quick and free. Once logged in, you can create a new workspace or use an existing one.

Then simply import the collection into your workspace to begin exploring and testing the API.

\n
💡 Already have an account? Just choose a workspace and import the collection — you’re ready to go!
\n

⚙️ Configure the collection

Here are the most important variables for running most request in the collection:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description
`api_host`	The url of Prysmex's backend https://b.prysmex.com
`client`	Most requests require a Space context, set your Space identifier here. Setting this value sets the Client-Subdomain header.
`api_key`	Your api key, setting this value sets the Authorization header. e.g. `ApiKey ge6gdAym9n5yvmUtZeMY`. This is required for requests inside the Authenticated endpoints folder.

You can set them by clicking on the collection and navigatint to the variables tab Prysmex API Documentation > Variables or by clicking the variables icon at the top right of this window as shown in the following image.

\n $\"Configure%20variables\"$ \n\n

Some additional variables include:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description
`locale`	locale
`time_zone`	time_zone
`refresh`	refresh

🚀 Run your first request!

Your set! Now select you first request and run it! Some requests require additional configuration, try running Authenticated endpoints > Users > GET me to display your current user.

Collection conventions

Variables are formatted like this
\n
Requests are organized in two main categories, Authenticated endpoints and Unauthenticated endpoints.
\n
API authentication is only available via ApiKey (Authorization Header), which you can generate from our app.
\n

API conventions

Data format - JSON API {}

ALMOST ALL of our APIs use the JSONAPI standard for rendering data. Please refer to the official json-api docs if you have any doubts about the standard.

Authentication

The following headers must be included in each request (Authorization only for authenticated endpoints). This collection takes care of this with your environment variables:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value
Client-Subdomain	my-client
Authorization	ApiKey ge6gdAym9n5yvmUtZeMY

JSON:API Headers

Since MOST APIs follow the JSON:API media type for structured JSON responses and requests.

📥 `Accept` Header (recommended for read requests)

Purpose: Tells the server that the client expects a JSON:API-formatted response.
Usage: Accept: application/vnd.api+json

Optional, but recommended — if omitted, the server will still return JSON:API responses by default.

📤 `Content-Type` Header (required for write requests)

Purpose: Declares that the request body is formatted as a JSON:API document.
Usage: Content-Type: application/vnd.api+json

Required for all requests that send a JSON:API body (e.g., POST, PATCH, PUT, etc..). This collection already handles this for all requests.

Try your first requests

Create a user group

curl -X POST \"https://b.prysmex.com/api/user_groups\" \\\n  -H \"Authorization: ApiKey your-key\" \\\n  -H \"Client-Subdomain: yourspace\" \\\n  -H \"Content-Type: application/vnd.api+json\" \\\n  -d '{ \"data\": { \"type\": \"user-groups\", \"attributes\": { \"name\": \"My first group\" } } }'\n\n

Search reports

curl -X POST \"https://b.prysmex.com/api/reports/search?page=1&per=10\" \\\n  -H \"Authorization: ApiKey your-key\" \\\n  -H \"Client-Subdomain: yourspace\" \\\n  -H \"Accept: application/vnd.api+json\"\n\n

Query params in body

Unless specified otherwise, parameters can be sent either in the query string or in the request body, and will be interpreted the same by the server.

For example, if a request requires a current_password parameter, you may send it in either format:

🔹 Option 1 – As a query parameter

curl -X PATCH \"https://b.prysmex.com/users/123?current_password=secret123\"\n\n

🔹 Option 2 – In the JSON request body

curl -X PATCH \"https://b.prysmex.com/users/123\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"current_password\": \"secret123\"}'\n\n

✅ Both options are valid and interchangeable for most endpoints.

\n
💡 For complex or structured data, using the JSON body is generally preferred.
\n

📌 Optional Query Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`time_zone`	String	Used to interpret or format time values. Accepts values like `America/Mexico_City`, `Etc/UTC`, `Europe/Brussels`, etc.
`refresh`	Boolean	Some models are searched through a search engine, which can make results not immediately available. Setting this param ensures they are searchable right after creation or update. Useful for real-time search results in testing or automation scenarios.

🌍 Locale Resolution

The application determines the language/locale for the request based on the following precedence:

locale query parameter (e.g., ?locale=es)
\n
current_user.locale (based on the authenticated user's preferences)
\n
Accept-Language request header (e.g., Accept-Language: en-US)
\n

\n
💡 This allows clients to override localization per request while still honoring user and browser preferences when no override is provided.
\n

Filtering / pagination

Pagination

Most search endpoints support pagination, use the following query params to control your pagination:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value	Description
page	int	Number of the page that you want to get data
per	int	Number of objects per page (max: 5000)

Basic filtering

// id equals 1\n{\n  \"id\": 1\n}\n// state equals (created OR pending) AND (id is greater than 1 and less than 5000)\n{\n  \"state\": [\"created\", \"pending\"],\n  \"id\": {\"gt\": 1, \"lte\": 5000}\n}\n// description contains 'some text' AND due_at is null AND cost is not null AND created_at in given range\n{\n  \"description\": \"some text\",\n  \"due_at\": null,\n  \"cost\": {\"exists\": true},\n  \"created_at\": {\"gt\": \"2024-01-01T06:00:00\", \"lt\": \"2025-01-19\"}\n}\n// Relative dates - current month\n{\n  \"created_at\": {\"gt\": \"now/M\", \"lt\": \"now+1M/M\"}\n}\n\n

Negating a query

You can easily negate a query by simply adding __negate: true

// NOT (state is done AND due_at is null)\n{\n  \"__negate\": true,\n  \"state\": [\"done\"],\n  \"due_at\": null\n}\n\n

Disabling a query

Disable a query by simply adding __disable: true

// This query will be ignored\n{\n  \"__disable\": true,\n  \"state\": [\"done\"]\n}\n\n

\n\n

If you need more control over AND/OR logic you can use a filter group. You can set the AND/OR evaluation via the type key (any, all). When type is set to any, filters are evaluated in OR context.

{\n  \"type\": \"any\", // or all\n  \"filters\": [\n    {\n      \"__negate\": true,\n      \"state\": [\"created\", \"pending\"],\n      \"id\": {\"gt\": 1, \"lte\": 5000}\n    },\n    {\n      \"created_by_id\": 50\n    }\n  ]\n}\n\n

__disable and __negate keywords can also be used in a filter group.

{\n  \"__negate\": true, // negate group\n  \"type\": \"any\",\n  \"filters\": [\n    {\n      \"__negate\": true, // negate filter\n      \"created_by_id\": 50\n    },\n    {\n      \"state\": [\"done\"]\n    }\n  ]\n}\n\n

Advanced filtering

You can nest another filter group inside a filter group.

{\n  \"type\": \"any\",\n  \"filters\": [\n    {...}, // a filter\n    {...}, // another filter\n    { // a nested filter group\n      \"type\": \"all\",\n      \"filters\": [\n        {...} // filter\n      ]\n    }\n  ]\n}\n\n

Custom serialization

Whenever you make a request, the data returned from the server might have more or less data that what you might need. You can use jsonapi's fields and include params to customize which data will be serialized from the server to fit your needs.

\n
This only applies to requests that returned jsonapi payloads, which is most of them
\n

fields `hash`

Allows you to filter which attributes and relationships will be rendered in the payload for each model type.

include `array`

Allows you to filter include related records in the included section of the payload. This is not by model type but rather the action relationship name.

links `boolean`

Adds links to records useful for fetching the record from the server or for navigating to the record in the app.

i18n `boolean` `string` `array`

Some records have translations via a schema (e.g. Report, Inspection, CertificateRequest, etc..). Use this option to serialize translated values.

Example

Here is an example of how a request made to /api/reports/1 using the fields and include params looks like:

payload

{\n    \"fields\": {\n        \"reports\": \"description,state,created_by,reviewer,i18n_documents,zones\",\n        \"users\": \"first_name\",\n        \"zones\": \"name\"\n    },\n    \"include\": [\"created_by\",\"reviewer\",\"zones\"],\n    \"links\": true,\n    \"i18n\": \"es\"\n}\n\n

response

{\n    \"data\": {\n        \"id\": \"1\",\n        \"type\": \"reports\",\n        \"attributes\": {\n            \"description\": \"Optio temporibus adipisci excepturi at. Sit enim saepe corrupti tempore. Veritatis modi commodi doloremque omnis vero ut.\\nPerspiciatis inventore ex culpa eveniet asperiores animi. Itaque voluptatem velit minima nihil quaerat nostrum illum. Facere ex ipsum corporis magnam. Dignissimos quo laborum recusandae laboriosam.\\nNostrum aliquam culpa consequatur dicta ipsum. Iusto rem voluptate totam error. Distinctio modi hic repellendus voluptatibus.\",\n            \"i18n-documents\": {\n                \"es\": {\n                    \"pictures\": [\n                        \"http://development.localhost:9000/uploads/prysmex/1/no_id/pictures/accident_1_32f7922e-ac48-4ee1-ac54-7f8eb3ce74fc.jpg\"\n                    ],\n                    \"shared_9fe60c\": {\n                        \"location9999\": [\n                            {\n                                \"lat\": 25.698535187692862,\n                                \"lng\": -100.29809969651323\n                            }\n                        ]\n                    }\n                }\n            },\n            \"state\": \"done\"\n        },\n        \"relationships\": {\n            \"created-by\": {\n                \"data\": {\n                    \"id\": \"10\",\n                    \"type\": \"users\"\n                }\n            },\n            \"reviewer\": {\n                \"data\": {\n                    \"id\": \"1\",\n                    \"type\": \"users\"\n                }\n            },\n            \"zones\": {\n                \"data\": [\n                    {\n                        \"id\": \"6\",\n                        \"type\": \"zones\"\n                    }\n                ]\n            }\n        },\n        \"links\": {\n            \"self\": \"http://localhost:3000/api/reports/1\",\n            \"app\": \"http://localhost:4200/s/prysmex/intents/custom?qs=(intent:(action:'in_app_navigation',payload:(to:'reports.show',args:(model_id:1))))\"\n        }\n    },\n    \"included\": [\n        {\n            \"id\": \"10\",\n            \"type\": \"users\",\n            \"attributes\": {\n                \"first-name\": \"Lawerence\"\n            },\n            \"relationships\": {}\n        },\n        {\n            \"id\": \"1\",\n            \"type\": \"users\",\n            \"attributes\": {\n                \"first-name\": \"Prysmex\"\n            },\n            \"relationships\": {}\n        },\n        {\n            \"id\": \"6\",\n            \"type\": \"zones\",\n            \"attributes\": {\n                \"name\": \"Distribution center-52\"\n            },\n            \"relationships\": {},\n            \"links\": {\n                \"self\": \"http://localhost:3000/api/zones/6\"\n            }\n        }\n    ]\n}\n\n

Security

To prevent a user from accessing that they are not authorized to access, non-admin users have limitations how much they can configure the serialized data via fields and include.

JSONAPI flat

Sometimes dealing with included resources in jsonapi can be a bit tedious, which is why we support serializing in a custom 'flattened' version of the SPEC. To use it, simply add the .jsonapi_flat extension to a GET request like this:

api/reports/1.jsonapi_flat

Here is an example of the same request with the original vs flattened version.

Original

{\n  \"data\": {\n    \"id\": \"53\",\n    \"type\": \"reports\",\n    \"attributes\": {\n      \"state\": \"created\"\n    },\n    \"relationships\": {\n      \"created-by\": {\n        \"data\": {\n          \"id\": \"9\",\n          \"type\": \"users\"\n        }\n      }\n    }\n  },\n  \"included\": [\n    {\n      \"id\": \"9\",\n      \"type\": \"users\",\n      \"attributes\": {\n        \"first-name\": \"Ehtel\"\n      },\n      \"relationships\": {}\n    }\n  ]\n}\n\n

Flattened

{\n  \"id\": \"53\",\n  \"type\": \"reports\",\n  \"attributes\": {\n    \"state\": \"created\"\n  },\n  \"relationships\": {\n    \"created-by\": {\n      \"data\": {\n        \"id\": \"9\",\n        \"type\": \"users\",\n        \"attributes\": {\n          \"first-name\": \"Ehtel\"\n        },\n        \"relationships\": {}\n      }\n    }\n  }\n}\n\n

Now all the data of the user co-located with the relationship, instead of having to search for a user name in the included section via its id.

Errors

Errors are returned in json-api errors format.
Here as some common errors when processing requests and when they might occure.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status Code	Meaning	Description
`401 Unauthorized`	Missing or invalid credentials	The request did not include valid authentication credentials (e.g., missing or expired token).
`403 Forbidden`	Access denied	Authentication was successful, but the user does not have permission to access the requested resource.
`422 Unprocessable Entity`	Invalid or incomplete request data	The request was well-formed but could not be processed due to semantic errors (e.g., missing required fields, invalid formats).

Error payload examples

Invalid api key 401

{\n    \"errors\": [\n        {\n            \"detail\": \"Invalid api key\"\n        }\n    ]\n}\n\n

Invalid payload when creating a resource. 422

{\n    \"errors\": [\n        {\n            \"status\": \"422\",\n            \"code\": \"blank\",\n            \"title\": \"Unprocessable Content\",\n            \"detail\": \"Nombre no puede estar en blanco\",\n            \"source\": {\n                \"pointer\": \"/data/attributes/name\"\n            }\n        },\n        {\n            \"status\": \"422\",\n            \"code\": \"too_short\",\n            \"title\": \"Unprocessable Content\",\n            \"detail\": \"Nombre es demasiado corto (3 caracteres mínimo)\",\n            \"source\": {\n                \"pointer\": \"/data/attributes/name\"\n            }\n        }\n    ]\n}\n\n

Bulk actions

Most models support bulk actions for create, update, and destroy. There are multiple advantages for using the bulk api when deleting multiple records:

Transaction - All or nothing, if anything, nothing is saved.
\n
Dry run - These endpoints support passing dry_run query param which will simulate the whole request without saving any change.
\n
Performance - Single request will always be faster than multiple requests.
\n

\n
For bulk actions, authorization runs per-instance e.g. meaning if you are deleting 10 records, the user MUST have permission to delete all 10 records.
\n

Create

To create multiple records, wrap the JSON:API payloads under a data key.

{\n  \"data\": [\n    {}, // create payload 1\n    {} // create payload 2\n  ]\n}\n\n

The endpoint is /bulk, for example, POST /api/reports/bulk. The endpoint returns a json object with an ids key, containing the created ids {ids: []}.

Update

To update multiple records, wrap the JSON:API payloads under a data key. The id is retrieved from each payload, under /data/id, make sure every update payload has the id available.

{\n  \"data\": [\n    {}, // update payload 1\n    {} // update payload 2\n  ]\n}\n\n

The endpoint is /bulk_update, for example, PATCH /api/reports/bulk_update. The endpoint returns no content.

Destroy

To destroy multiple records, use the DELETE /api/reports endpoint. To select which records to delete, you must use one of two options.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Param	Description
`ids`	Array of ids. This will validate that all ids exist.
`filters`	See the filtering spec.

The endpoint returns a json object with an ids key, containing the created ids {ids: []}.

\n
⚠ Note that different users might select different reports to delete due to their read authorizations
\n

Nested actions

Some models allow to modify nested resources in a create / update request by using the included keyword (create, update) and _destroy attribute (destroy).

Some examples are:

Creating an Inspection along with its associated Report(s) in the same request.
\n
Modifying an Inspection, removing an existing associated report and adding a new report.
\n

Here is a summary table that illustrates the posibilities.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Main resource action	Possible nested resource action
create	create
update	create, update, destroy

Example: Creating an Inspection with a Report

As you can see, the report is a regular JSON:API request nested inside the included keyword. It's vital to add the relationship in the parent to the child.

{\n    \"data\": {\n        \"id\": \"local-d37ij9\",\n        \"attributes\": {\n            \"document\": {\n                \"text2\": \"My text\"\n            }\n        },\n        \"relationships\": {\n            \"project\": {\n                \"data\": {\n                    \"type\": \"projects\",\n                    \"id\": \"1\"\n                }\n            },\n            \"reports\": {\n                \"data\": [\n                    {\n                        \"type\": \"reports\",\n                        \"id\": \"local-463m0o\"\n                    }\n                ]\n            },\n            \"schema-template-version\": {\n                \"data\": {\n                    \"type\": \"inspection-schema-templates\",\n                    \"id\": \"2\"\n                }\n            }\n        },\n        \"included\": [\n            {\n                \"id\": \"local-463m0o\",\n                \"attributes\": {\n                    \"description\": \"Some description\",\n                    \"document\": {\n                        \"pictures\": [],\n                        \"meta\": {}\n                    }\n                },\n                \"relationships\": {\n                    \"project\": {\n                        \"data\": {\n                            \"type\": \"projects\",\n                            \"id\": \"1\"\n                        }\n                    },\n                    \"schema-template-version\": {\n                        \"data\": {\n                            \"type\": \"report-schema-templates\",\n                            \"id\": \"6\"\n                        }\n                    }\n                },\n                \"type\": \"reports\",\n                \"lid\": \"@ember-data:lid-report-local-463m0o\"\n            }\n        ],\n        \"type\": \"inspections\",\n        \"lid\": \"@ember-data:lid-inspection-local-d37ij9\"\n    }\n}\n\n

Example: Updating an Inspection deleting existing Report and adding a new Report

To delete a record, it must be marked with the -destroy attribute.

{\n    \"data\": {\n        \"id\": \"146\",\n        \"attributes\": {\n            \"document\": {\n                \"text2\": \"My updated text\"\n            }\n        },\n        \"relationships\": {\n            \"reports\": {\n                \"data\": [\n                    {\n                        \"type\": \"reports\",\n                        \"id\": \"local-6jl3h\"\n                    },\n                    {\n                        \"type\": \"reports\",\n                        \"id\": \"179\"\n                    }\n                ]\n            },\n            \"schema-template-version\": {\n                \"data\": {\n                    \"type\": \"inspection-schema-templates\",\n                    \"id\": \"2\"\n                }\n            }\n        },\n        \"included\": [\n            {\n                \"id\": \"179\",\n                \"type\": \"reports\",\n                \"attributes\": {\n                    \"-destroy\": true\n                }\n            },\n            {\n                \"id\": \"local-6jl3h\",\n                \"attributes\": {\n                    \"description\": \"Some description\",\n                    \"document\": {\n                        \"pictures\": [],\n                        \"meta\": {}\n                    }\n                },\n                \"relationships\": {\n                    \"project\": {\n                        \"data\": {\n                            \"type\": \"projects\",\n                            \"id\": \"1\"\n                        }\n                    },\n                    \"schema-template-version\": {\n                        \"data\": {\n                            \"type\": \"report-schema-templates\",\n                            \"id\": \"6\"\n                        }\n                    }\n                },\n                \"type\": \"reports\",\n                \"lid\": \"@ember-data:lid-report-local-6jl3h\"\n            }\n        ],\n        \"type\": \"inspections\",\n        \"lid\": \"@ember-data:lid-inspection-local-d37ij9\"\n    }\n}\n\n

Data models

Doc conventions

This docs are a collection are organized into two major categories Authenticated endpoints and Unauthenticated endpoints, which then are organized by data model (e.g. Users, Clients, Reports, etc...). Inside each folder, you'll find example requests that range from creating, updating, searching, deleting to other model specific requests. At the beginning of each directory, you'll find a section called Data Model that contains a representation of the database table for that model with the following divided into two categories:

🔒 System-managed attributes: Set or updated automatically by the system. These cannot be provided or modified through the API.
\n
📤 API-settable attributes: Fields that can be created or updated by the client when interacting with the API.
\n

See Common Data Model attributes table to new an example of how each model table looks like.

\n
This postman collection contains requests for all models that exist in our platform and we do our best to maintain them up to date. If you have any issues, o need help, feel free to contact us in the live chat in our app at https://app.prysmex.com.
\n

Common Data Model attributes

Each data model contains a table with its attributes (columns). Since most data models contain the following attributes, they are NOT listed on each of the tables.

📤 Settable

\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Default	Description

🔒 System managed

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Default	Description
created_at*	datetime	timestamp for now	Timestamp when the record was created (system-managed)
updated_at*	datetime	timestamp for now	Timestamp when the record was last updated (system-managed)
deleted_at	datetime	null	Soft-deletion timestamp (system-managed)
created_by_id*	integer	id if current `User`	ID of the `User` who created this record (system-managed)
last_updated_by_id	integer	null	ID of the `User` who last updated this record (system-managed)
last_deleted_by_id	integer	null	ID of the `User` who deleted this record (system-managed)

Disclaimers

🚫 API versioning is not currently supported. This means that new releases may introduce breaking changes without prior notice. Please monitor updates closely and test your integrations regularly.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Setup","slug":"setup"},{"content":"Collection conventions","slug":"collection-conventions"},{"content":"API conventions","slug":"api-conventions"},{"content":"Filtering / pagination","slug":"filtering-pagination"},{"content":"Custom serialization","slug":"custom-serialization"},{"content":"JSONAPI flat","slug":"jsonapi-flat"},{"content":"Errors","slug":"errors"},{"content":"Bulk actions","slug":"bulk-actions"},{"content":"Nested actions","slug":"nested-actions"},{"content":"Data models","slug":"data-models"},{"content":"Disclaimers","slug":"disclaimers"}],"owner":"420467","collectionId":"f3effbb7-d678-47b0-8b9c-6f7fca3d9f76","publishedId":"2sB2qgeJZQ","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"0277cc"},"publishDate":"2025-07-05T05:11:47.000Z"},"item":[{"name":"Authenticated endpoints","item":[{"name":"Clients","item":[{"name":"index","id":"47fa0b6c-c42a-4646-947e-886680886443","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":"https://b.prysmex.com/api/clients?per=5&page=1","description":"

Use this endpoint to search for all Clients you are authorized to view. You can filter results using any of the attributes defined in the Client Data Model.

Use this endpoint to fetch a Client by id.

Use this endpoint to create a Client.

Use this endpoint to update a Client.

Use this endpoint to delete a Client. This request requires password via current_password param, if mfa is active it must also be passed as code.

DANGER All of the data inside this client will be permanently lost.

Use this endpoint to accept an invite that was previously created for a User. An invitation for the current User must previously exist.

identifier of the client you want access to

\n","type":"text/plain"},"type":"any","value":"client-global","key":"subdomain"}]}},"response":[{"id":"440afd3b-e1e6-4e02-9217-361e9056a142","name":"request_access","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"description\": \"I need access to this awesome space!\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://b.prysmex.com/api/clients/:subdomain/request_access","host":["https://b.prysmex.com"],"path":["api","clients",":subdomain","request_access"],"variable":[{"key":"subdomain","value":"client-global","description":"identifier of the client you want access to"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"0"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"strict-origin-when-cross-origin"},{"key":"vary","value":"Client-Subdomain"},{"key":"vary","value":"Accept-Encoding, Origin"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-encoding","value":"gzip"},{"key":"cache-control","value":"no-cache"},{"key":"x-request-id","value":"117d8565-f75b-409d-bbb1-3668d67466dc"},{"key":"x-runtime","value":"0.052996"},{"key":"server-timing","value":"start_processing.action_controller;dur=0.01, cache_read.active_support;dur=0.05, sql.active_record;dur=10.64, cache_write.active_support;dur=0.14, instantiation.active_record;dur=0.65, start_transaction.active_record;dur=0.01, transaction.active_record;dur=3.89, enqueue.active_job;dur=0.38, process_action.action_controller;dur=39.26"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"559ac2c3-ba70-41a8-b6ac-cb89c33f60f8"}],"id":"6c6d9f96-5559-4713-bb4e-775481fd0145","description":"

Attributes

Data Model

The following tables describe the attributes available for this model, divided into two categories: 📤 API-settable and 🔒 System-managed attributes.

📤 Settable

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Default	Description
name*	string	null	Friendly name for the client
identifier*	string	auto generates from name	Unique identifier code
max_daily_campaings_per_user*	integer	`1`	Limits the amount of campaigns displayed to a user
extra_info	json	`{}`
authorizations_config_role_override	json	null
user_schema*	json	`{}`	JSON structure defining custom user schema
home_page_mapping	json	null

🔒 System managed

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Default	Description
feature_flags*	json	`{}`	Features available based on paid plan
status*	integer	`0`	Status of the client: `0 = active`, `1 = disabled`
user_id*	bigint	same as created_by_id	Owner of the client
active_subdomain*	boolean	`false`	Whether the client has a subdomain
max_projects	integer	null
max_seats	integer	integer
stripe_customer_id	string	null
stripe_subscription	jsonb	null	Stripe subscription details
paid_full_seats*	integer	integer
teams_trial_started_at	datetime	null	Timestamp when Teams trial started
teams_pro_trial_started_at	datetime	null	Timestamp when Teams Pro trial started
domains*	string[]	`[]`	Allowed domains for the client

See Common Attributes

🔗 Relationships

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description
`user`	User	The owner of the client

","_postman_id":"6c6d9f96-5559-4713-bb4e-775481fd0145","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","name":"Authenticated endpoints","type":"folder"}}},{"name":"Users","item":[{"name":"me","event":[{"listen":"prerequest","script":{"id":"7c09b0b7-e776-4799-9175-b293a280e2a8","exec":[""],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"id":"62da3cfa-6021-4aad-b41d-1650b8cbf9f5","exec":[""],"type":"text/javascript","packages":{}}}],"id":"da2d5dea-f87f-460e-89bc-3dfd13d0b657","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://b.prysmex.com/api/users/me","description":"

Returns the current user. It also returns the clients (Spaces) associated with that user.

This endpoint is meant to be used internally (private)

Returns a hash with the certificate status for a set of users.

Creates a local user.

Required attributes

first-name
\n
username (unless role gives no app access)
\n
email (unless password is present or role gives no app access)
\n
password (unless email is present or role gives no app access)
\n

Required relationships

role

Creates a local user.

Required attributes

first-name
\n
username (unless role gives no app access)
\n
email (unless password is present or role gives no app access)
\n
password (unless email is present or role gives no app access)
\n

Required relationships

role

Creates if necessary and invites a non-local user to the current Space.

Required attributes

first-name
\n
email
\n

Required relationships

role

Creates if necessary and invites a non-local user to the current Space.

Required attributes

first-name
\n
email
\n

Required relationships

role

Creates if necessary and invites a non-local user to the current Space.

Required attributes

first-name
\n
email
\n

Required relationships

role

Allows searching for users that you have the authorization to view

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","name":"Authenticated endpoints","type":"folder"}},"urlObject":{"path":["api","users","search"],"host":["https://b.prysmex.com"],"query":[{"key":"page","value":"1"},{"key":"per","value":"10"},{"key":"sort","value":"id"},{"key":"sort_direction","value":"asc"}],"variable":[]}},"response":[{"id":"3d38e31b-524f-4c61-8fb7-7d63214899f7","name":"search","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"with_current_project_id\": [\"2\"]\n // \"with_authorization\": {\n // \"model\": \"CertificateRequest\",\n // \"id\": 1,\n // // \"attributes\": {\"schema_template_id\": 50},\n // \"action\": \"change_state\"\n // }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://b.prysmex.com/api/users/search?page=1&per=10&sort=id&sort_direction=asc","host":["https://b.prysmex.com"],"path":["api","users","search"],"query":[{"key":"page","value":"1"},{"key":"per","value":"10"},{"key":"sort","value":"id"},{"key":"sort_direction","value":"asc"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"0"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"strict-origin-when-cross-origin"},{"key":"vary","value":"Client-Subdomain"},{"key":"vary","value":"Accept-Encoding, Origin"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-encoding","value":"gzip"},{"key":"cache-control","value":"no-cache"},{"key":"x-request-id","value":"b605a7b2-0583-4dd0-ad36-1c27c2e823d1"},{"key":"x-runtime","value":"0.136210"},{"key":"server-timing","value":"start_processing.action_controller;dur=0.01, cache_read.active_support;dur=0.03, sql.active_record;dur=16.18, cache_write.active_support;dur=0.06, instantiation.active_record;dur=2.92, start_transaction.active_record;dur=0.00, transaction.active_record;dur=2.41, process_action.action_controller;dur=110.32"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"1\",\n \"type\": \"users\",\n \"attributes\": {\n \"accepted-at\": \"2025-07-01T00:00:48.375Z\",\n \"archived-at\": null,\n \"auto-archives-at\": null,\n \"birth-date\": null,\n \"blood-type\": null,\n \"client-id\": 1,\n \"confirmation-sent-at\": null,\n \"confirmed-at\": null,\n \"contract-type\": \"employee\",\n \"country\": null,\n \"created-at\": \"2025-07-01T00:00:48.386Z\",\n \"created-by-id\": 2,\n \"current-sign-in-at\": \"2025-07-03T21:17:30.250Z\",\n \"current-sign-in-ip\": \"192.168.65.1\",\n \"date-format\": \"DD/MM/YYYY\",\n \"date-time-format\": \"lll\",\n \"document\": {},\n \"email\": \"admin@prysmex.com\",\n \"email-authenticatable\": false,\n \"email-blocked-until\": null,\n \"first-name\": \"Prysmex\",\n \"global-role\": null,\n \"insurance-num\": null,\n \"invitation-email-sent-at\": null,\n \"invite-id\": null,\n \"is-active\": true,\n \"is-local\": true,\n \"join-company-at\": null,\n \"labor-hours-start\": \"07:30:00\",\n \"last-invited-archived-at\": null,\n \"last-name\": \"Admin\",\n \"locale\": \"es\",\n \"metadata\": {\n \"toursTaken\": [\n \"admin_users_tour\",\n \"navigation_tour\",\n \"home_tour\"\n ],\n \"completedEntries\": []\n },\n \"password-changed-at\": null,\n \"payroll-num\": null,\n \"phone-num\": null,\n \"picture-url\": null,\n \"position\": null,\n \"privacy-accepted-date\": \"2025-07-01T00:11:24.793Z\",\n \"seat-type\": \"full\",\n \"send-notifications-by-email\": true,\n \"send-weekly-summary-by-email\": true,\n \"sign-in-count\": 7,\n \"support-client-subdomains\": [],\n \"time-zone\": null,\n \"updated-at\": \"2025-07-01T00:00:48.386Z\",\n \"username\": \"prysmex_admin\",\n \"working-regime\": \"moderate\"\n },\n \"relationships\": {\n \"created-by\": {\n \"data\": {\n \"id\": \"2\",\n \"type\": \"users\"\n }\n },\n \"last-invited-archived-by\": {\n \"data\": null\n },\n \"last-updated-by\": {\n \"data\": null\n },\n \"projects\": {\n \"data\": []\n },\n \"role\": {\n \"data\": {\n \"id\": \"1\",\n \"type\": \"roles\"\n }\n },\n \"user-groups\": {\n \"data\": [\n {\n \"id\": \"5\",\n \"type\": \"user-groups\"\n }\n ]\n },\n \"zones\": {\n \"data\": []\n }\n }\n },\n {\n \"id\": \"3\",\n \"type\": \"users\",\n \"attributes\": {\n \"accepted-at\": \"2025-07-01T00:02:12.722Z\",\n \"archived-at\": null,\n \"auto-archives-at\": null,\n \"birth-date\": \"2004-07-01\",\n \"blood-type\": null,\n \"client-id\": 1,\n \"confirmation-sent-at\": \"2025-07-01T00:02:13.069Z\",\n \"confirmed-at\": null,\n \"contract-type\": \"employee\",\n \"country\": \"Saint Lucia\",\n \"created-at\": \"2025-07-01T00:02:12.731Z\",\n \"created-by-id\": 1,\n \"current-sign-in-at\": \"2025-07-03T01:52:30.018Z\",\n \"current-sign-in-ip\": \"192.168.65.1\",\n \"date-format\": \"MM-DD-YYYY\",\n \"date-time-format\": \"lll\",\n \"document\": {\n \"meta\": {}\n },\n \"email\": \"prysmex@prysmex.com\",\n \"email-authenticatable\": true,\n \"email-blocked-until\": null,\n \"first-name\": \"Prysmex\",\n \"global-role\": null,\n \"insurance-num\": null,\n \"invitation-email-sent-at\": \"2025-07-01T00:02:13.069Z\",\n \"invite-id\": null,\n \"is-active\": true,\n \"is-local\": true,\n \"join-company-at\": null,\n \"labor-hours-start\": \"07:30:00\",\n \"last-invited-archived-at\": null,\n \"last-name\": \"User\",\n \"locale\": \"es\",\n \"metadata\": {\n \"toursTaken\": [\n \"admin_users_tour\",\n \"navigation_tour\",\n \"admin_user_groups_tour\",\n \"home_tour\",\n \"map_tour\",\n \"inspections_tour\",\n \"inspections_show_tour\",\n \"reports_show_tour\"\n ],\n \"completedEntries\": []\n },\n \"password-changed-at\": null,\n \"payroll-num\": null,\n \"phone-num\": \"+5216439598421\",\n \"picture-url\": \"http://localhost:3000/uploads/prysmex/1/no_id/pictures/user_female_9019789d-c8e2-49f6-9f42-0dedc1476960.jpg\",\n \"position\": null,\n \"privacy-accepted-date\": \"2025-07-02T18:06:27.451Z\",\n \"seat-type\": \"full\",\n \"send-notifications-by-email\": true,\n \"send-weekly-summary-by-email\": true,\n \"sign-in-count\": 2,\n \"support-client-subdomains\": [\n \"new-ic67e68d\"\n ],\n \"time-zone\": null,\n \"updated-at\": \"2025-07-02T18:06:40.511Z\",\n \"username\": \"prysmex_prysmex\",\n \"working-regime\": \"moderate\"\n },\n \"relationships\": {\n \"created-by\": {\n \"data\": {\n \"id\": \"1\",\n \"type\": \"users\"\n }\n },\n \"last-invited-archived-by\": {\n \"data\": null\n },\n \"last-updated-by\": {\n \"data\": {\n \"id\": \"3\",\n \"type\": \"users\"\n }\n },\n \"projects\": {\n \"data\": []\n },\n \"role\": {\n \"data\": {\n \"id\": \"7\",\n \"type\": \"roles\"\n }\n },\n \"user-groups\": {\n \"data\": [\n {\n \"id\": \"3\",\n \"type\": \"user-groups\"\n },\n {\n \"id\": \"4\",\n \"type\": \"user-groups\"\n }\n ]\n },\n \"zones\": {\n \"data\": []\n }\n }\n },\n {\n \"id\": \"4\",\n \"type\": \"users\",\n \"attributes\": {\n \"accepted-at\": \"2025-07-01T00:02:12.912Z\",\n \"archived-at\": null,\n \"auto-archives-at\": null,\n \"birth-date\": \"2001-06-07\",\n \"blood-type\": null,\n \"client-id\": 1,\n \"confirmation-sent-at\": \"2025-07-01T00:02:13.635Z\",\n \"confirmed-at\": null,\n \"contract-type\": \"employee\",\n \"country\": \"Ukraine\",\n \"created-at\": \"2025-07-01T00:02:12.924Z\",\n \"created-by-id\": 1,\n \"current-sign-in-at\": null,\n \"current-sign-in-ip\": null,\n \"date-format\": \"ll\",\n \"date-time-format\": \"lll\",\n \"document\": {\n \"meta\": {}\n },\n \"email\": \"halvorson.jadwiga@corkery.ca\",\n \"email-authenticatable\": false,\n \"email-blocked-until\": null,\n \"first-name\": \"Jadwiga\",\n \"global-role\": null,\n \"insurance-num\": null,\n \"invitation-email-sent-at\": \"2025-07-01T00:02:13.635Z\",\n \"invite-id\": null,\n \"is-active\": true,\n \"is-local\": true,\n \"join-company-at\": null,\n \"labor-hours-start\": \"07:30:00\",\n \"last-invited-archived-at\": null,\n \"last-name\": \"Halvorson\",\n \"locale\": \"es\",\n \"metadata\": {},\n \"password-changed-at\": null,\n \"payroll-num\": null,\n \"phone-num\": \"+5219190400595\",\n \"picture-url\": \"http://localhost:3000/uploads/prysmex/1/no_id/pictures/user_female_058fc97d-4b38-4f26-ae50-b063037b7287.jpg\",\n \"position\": null,\n \"privacy-accepted-date\": null,\n \"seat-type\": \"full\",\n \"send-notifications-by-email\": true,\n \"send-weekly-summary-by-email\": true,\n \"sign-in-count\": 0,\n \"support-client-subdomains\": [],\n \"time-zone\": null,\n \"updated-at\": \"2025-07-02T18:55:53.623Z\",\n \"username\": \"halvorson.jadwiga\",\n \"working-regime\": \"moderate\"\n },\n \"relationships\": {\n \"created-by\": {\n \"data\": {\n \"id\": \"1\",\n \"type\": \"users\"\n }\n },\n \"last-invited-archived-by\": {\n \"data\": null\n },\n \"last-updated-by\": {\n \"data\": {\n \"id\": \"3\",\n \"type\": \"users\"\n }\n },\n \"projects\": {\n \"data\": [\n {\n \"id\": \"2\",\n \"type\": \"projects\"\n },\n {\n \"id\": \"1\",\n \"type\": \"projects\"\n }\n ]\n },\n \"role\": {\n \"data\": {\n \"id\": \"3\",\n \"type\": \"roles\"\n }\n },\n \"user-groups\": {\n \"data\": []\n },\n \"zones\": {\n \"data\": []\n }\n }\n },\n {\n \"id\": \"5\",\n \"type\": \"users\",\n \"attributes\": {\n \"accepted-at\": \"2025-07-01T00:02:12.995Z\",\n \"archived-at\": null,\n \"auto-archives-at\": null,\n \"birth-date\": \"2004-07-01\",\n \"blood-type\": null,\n \"client-id\": 1,\n \"confirmation-sent-at\": \"2025-07-01T00:02:14.328Z\",\n \"confirmed-at\": null,\n \"contract-type\": \"employee\",\n \"country\": \"Trinidad and Tobago\",\n \"created-at\": \"2025-07-01T00:02:13.030Z\",\n \"created-by-id\": 1,\n \"current-sign-in-at\": null,\n \"current-sign-in-ip\": null,\n \"date-format\": \"DD-MM-YYYY\",\n \"date-time-format\": \"lll\",\n \"document\": {},\n \"email\": \"mueller_karan@kutchstokes.biz\",\n \"email-authenticatable\": false,\n \"email-blocked-until\": null,\n \"first-name\": \"Karan\",\n \"global-role\": null,\n \"insurance-num\": null,\n \"invitation-email-sent-at\": \"2025-07-01T00:02:14.328Z\",\n \"invite-id\": null,\n \"is-active\": true,\n \"is-local\": true,\n \"join-company-at\": null,\n \"labor-hours-start\": \"07:30:00\",\n \"last-invited-archived-at\": null,\n \"last-name\": \"Mueller\",\n \"locale\": \"en\",\n \"metadata\": {},\n \"password-changed-at\": null,\n \"payroll-num\": null,\n \"phone-num\": \"+5216818130240\",\n \"picture-url\": \"http://localhost:3000/uploads/prysmex/1/no_id/pictures/user_female_aa3fd3a0-608a-4cac-894a-b2785cb5a6c3.jpg\",\n \"position\": null,\n \"privacy-accepted-date\": null,\n \"seat-type\": \"full\",\n \"send-notifications-by-email\": true,\n \"send-weekly-summary-by-email\": true,\n \"sign-in-count\": 0,\n \"support-client-subdomains\": [],\n \"time-zone\": null,\n \"updated-at\": \"2025-07-01T00:02:14.363Z\",\n \"username\": \"karan_mueller\",\n \"working-regime\": \"moderate\"\n },\n \"relationships\": {\n \"created-by\": {\n \"data\": {\n \"id\": \"1\",\n \"type\": \"users\"\n }\n },\n \"last-invited-archived-by\": {\n \"data\": null\n },\n \"last-updated-by\": {\n \"data\": null\n },\n \"projects\": {\n \"data\": [\n {\n \"id\": \"2\",\n \"type\": \"projects\"\n },\n {\n \"id\": \"1\",\n \"type\": \"projects\"\n }\n ]\n },\n \"role\": {\n \"data\": {\n \"id\": \"3\",\n \"type\": \"roles\"\n }\n },\n \"user-groups\": {\n \"data\": [\n {\n \"id\": \"4\",\n \"type\": \"user-groups\"\n }\n ]\n },\n \"zones\": {\n \"data\": [\n {\n \"id\": \"19\",\n \"type\": \"zones\"\n }\n ]\n }\n }\n },\n {\n \"id\": \"6\",\n \"type\": \"users\",\n \"attributes\": {\n \"accepted-at\": \"2025-07-01T00:02:13.069Z\",\n \"archived-at\": null,\n \"auto-archives-at\": null,\n \"birth-date\": \"2004-07-01\",\n \"blood-type\": null,\n \"client-id\": 1,\n \"confirmation-sent-at\": \"2025-07-01T00:02:14.551Z\",\n \"confirmed-at\": null,\n \"contract-type\": \"employee\",\n \"country\": \"Montserrat\",\n \"created-at\": \"2025-07-01T00:02:13.082Z\",\n \"created-by-id\": 1,\n \"current-sign-in-at\": null,\n \"current-sign-in-ip\": null,\n \"date-format\": \"DD/MM/YYYY\",\n \"date-time-format\": \"lll\",\n \"document\": {},\n \"email\": \"larson_rebbeca@olsonhamill.us\",\n \"email-authenticatable\": false,\n \"email-blocked-until\": null,\n \"first-name\": \"Rebbeca\",\n \"global-role\": null,\n \"insurance-num\": null,\n \"invitation-email-sent-at\": \"2025-07-01T00:02:14.550Z\",\n \"invite-id\": null,\n \"is-active\": true,\n \"is-local\": true,\n \"join-company-at\": null,\n \"labor-hours-start\": \"07:30:00\",\n \"last-invited-archived-at\": null,\n \"last-name\": \"Larson\",\n \"locale\": \"en\",\n \"metadata\": {},\n \"password-changed-at\": null,\n \"payroll-num\": null,\n \"phone-num\": \"+5210772503707\",\n \"picture-url\": \"http://localhost:3000/uploads/prysmex/1/no_id/pictures/user_female_e94401f2-4a47-4ef9-abfd-e223a388a56b.jpg\",\n \"position\": null,\n \"privacy-accepted-date\": null,\n \"seat-type\": \"full\",\n \"send-notifications-by-email\": true,\n \"send-weekly-summary-by-email\": true,\n \"sign-in-count\": 0,\n \"support-client-subdomains\": [],\n \"time-zone\": null,\n \"updated-at\": \"2025-07-01T00:02:14.594Z\",\n \"username\": \"larson_rebbeca\",\n \"working-regime\": \"moderate\"\n },\n \"relationships\": {\n \"created-by\": {\n \"data\": {\n \"id\": \"1\",\n \"type\": \"users\"\n }\n },\n \"last-invited-archived-by\": {\n \"data\": null\n },\n \"last-updated-by\": {\n \"data\": null\n },\n \"projects\": {\n \"data\": [\n {\n \"id\": \"2\",\n \"type\": \"projects\"\n },\n {\n \"id\": \"1\",\n \"type\": \"projects\"\n }\n ]\n },\n \"role\": {\n \"data\": {\n \"id\": \"4\",\n \"type\": \"roles\"\n }\n },\n \"user-groups\": {\n \"data\": [\n {\n \"id\": \"3\",\n \"type\": \"user-groups\"\n }\n ]\n },\n \"zones\": {\n \"data\": [\n {\n \"id\": \"3\",\n \"type\": \"zones\"\n },\n {\n \"id\": \"4\",\n \"type\": \"zones\"\n }\n ]\n }\n }\n },\n {\n \"id\": \"7\",\n \"type\": \"users\",\n \"attributes\": {\n \"accepted-at\": \"2025-07-01T00:02:13.112Z\",\n \"archived-at\": null,\n \"auto-archives-at\": null,\n \"birth-date\": \"2004-07-01\",\n \"blood-type\": null,\n \"client-id\": 1,\n \"confirmation-sent-at\": \"2025-07-01T00:02:14.438Z\",\n \"confirmed-at\": null,\n \"contract-type\": \"employee\",\n \"country\": \"Morocco\",\n \"created-at\": \"2025-07-01T00:02:13.127Z\",\n \"created-by-id\": 1,\n \"current-sign-in-at\": null,\n \"current-sign-in-ip\": null,\n \"date-format\": \"MM/DD/YYYY\",\n \"date-time-format\": \"lll\",\n \"document\": {},\n \"email\": \"phung.cole@ryan.name\",\n \"email-authenticatable\": false,\n \"email-blocked-until\": null,\n \"first-name\": \"Phung\",\n \"global-role\": null,\n \"insurance-num\": null,\n \"invitation-email-sent-at\": \"2025-07-01T00:02:14.438Z\",\n \"invite-id\": null,\n \"is-active\": true,\n \"is-local\": true,\n \"join-company-at\": null,\n \"labor-hours-start\": \"07:30:00\",\n \"last-invited-archived-at\": null,\n \"last-name\": \"Cole\",\n \"locale\": \"es\",\n \"metadata\": {},\n \"password-changed-at\": null,\n \"payroll-num\": null,\n \"phone-num\": \"+5212679826556\",\n \"picture-url\": \"http://localhost:3000/uploads/prysmex/1/no_id/pictures/user_female_7c77cb95-80ea-4ee5-87cb-8102eccfd4a0.jpg\",\n \"position\": null,\n \"privacy-accepted-date\": null,\n \"seat-type\": \"full\",\n \"send-notifications-by-email\": true,\n \"send-weekly-summary-by-email\": true,\n \"sign-in-count\": 0,\n \"support-client-subdomains\": [],\n \"time-zone\": null,\n \"updated-at\": \"2025-07-01T00:02:14.455Z\",\n \"username\": \"cole_phung\",\n \"working-regime\": \"moderate\"\n },\n \"relationships\": {\n \"created-by\": {\n \"data\": {\n \"id\": \"1\",\n \"type\": \"users\"\n }\n },\n \"last-invited-archived-by\": {\n \"data\": null\n },\n \"last-updated-by\": {\n \"data\": null\n },\n \"projects\": {\n \"data\": [\n {\n \"id\": \"2\",\n \"type\": \"projects\"\n },\n {\n \"id\": \"1\",\n \"type\": \"projects\"\n }\n ]\n },\n \"role\": {\n \"data\": {\n \"id\": \"3\",\n \"type\": \"roles\"\n }\n },\n \"user-groups\": {\n \"data\": [\n {\n \"id\": \"1\",\n \"type\": \"user-groups\"\n },\n {\n \"id\": \"4\",\n \"type\": \"user-groups\"\n }\n ]\n },\n \"zones\": {\n \"data\": [\n {\n \"id\": \"17\",\n \"type\": \"zones\"\n }\n ]\n }\n }\n },\n {\n \"id\": \"8\",\n \"type\": \"users\",\n \"attributes\": {\n \"accepted-at\": \"2025-07-01T00:02:13.153Z\",\n \"archived-at\": null,\n \"auto-archives-at\": null,\n \"birth-date\": \"2004-07-01\",\n \"blood-type\": null,\n \"client-id\": 1,\n \"confirmation-sent-at\": \"2025-07-01T00:02:15.208Z\",\n \"confirmed-at\": null,\n \"contract-type\": \"employee\",\n \"country\": \"Romania\",\n \"created-at\": \"2025-07-01T00:02:13.166Z\",\n \"created-by-id\": 1,\n \"current-sign-in-at\": null,\n \"current-sign-in-ip\": null,\n \"date-format\": \"MM-DD-YYYY\",\n \"date-time-format\": \"lll\",\n \"document\": {},\n \"email\": \"okeefe_jerilyn@aufderhardouglas.name\",\n \"email-authenticatable\": false,\n \"email-blocked-until\": null,\n \"first-name\": \"Jerilyn\",\n \"global-role\": null,\n \"insurance-num\": null,\n \"invitation-email-sent-at\": \"2025-07-01T00:02:15.208Z\",\n \"invite-id\": null,\n \"is-active\": true,\n \"is-local\": true,\n \"join-company-at\": null,\n \"labor-hours-start\": \"07:30:00\",\n \"last-invited-archived-at\": null,\n \"last-name\": \"O'keefe\",\n \"locale\": \"en\",\n \"metadata\": {},\n \"password-changed-at\": null,\n \"payroll-num\": null,\n \"phone-num\": \"+5213309869266\",\n \"picture-url\": \"http://localhost:3000/uploads/prysmex/1/no_id/pictures/user_male_80ab92bc-95ed-42f4-a30b-0586e9ba3809.jpg\",\n \"position\": null,\n \"privacy-accepted-date\": null,\n \"seat-type\": \"full\",\n \"send-notifications-by-email\": true,\n \"send-weekly-summary-by-email\": true,\n \"sign-in-count\": 0,\n \"support-client-subdomains\": [],\n \"time-zone\": null,\n \"updated-at\": \"2025-07-01T00:02:15.234Z\",\n \"username\": \"okeefe.jerilyn\",\n \"working-regime\": \"moderate\"\n },\n \"relationships\": {\n \"created-by\": {\n \"data\": {\n \"id\": \"1\",\n \"type\": \"users\"\n }\n },\n \"last-invited-archived-by\": {\n \"data\": null\n },\n \"last-updated-by\": {\n \"data\": null\n },\n \"projects\": {\n \"data\": [\n {\n \"id\": \"2\",\n \"type\": \"projects\"\n },\n {\n \"id\": \"1\",\n \"type\": \"projects\"\n }\n ]\n },\n \"role\": {\n \"data\": {\n \"id\": \"3\",\n \"type\": \"roles\"\n }\n },\n \"user-groups\": {\n \"data\": [\n {\n \"id\": \"3\",\n \"type\": \"user-groups\"\n },\n {\n \"id\": \"2\",\n \"type\": \"user-groups\"\n }\n ]\n },\n \"zones\": {\n \"data\": []\n }\n }\n },\n {\n \"id\": \"9\",\n \"type\": \"users\",\n \"attributes\": {\n \"accepted-at\": \"2025-07-01T00:02:13.207Z\",\n \"archived-at\": null,\n \"auto-archives-at\": null,\n \"birth-date\": \"2004-07-01\",\n \"blood-type\": null,\n \"client-id\": 1,\n \"confirmation-sent-at\": \"2025-07-01T00:02:15.511Z\",\n \"confirmed-at\": null,\n \"contract-type\": \"employee\",\n \"country\": \"Spain\",\n \"created-at\": \"2025-07-01T00:02:13.218Z\",\n \"created-by-id\": 1,\n \"current-sign-in-at\": null,\n \"current-sign-in-ip\": null,\n \"date-format\": \"MM/DD/YYYY\",\n \"date-time-format\": \"lll\",\n \"document\": {},\n \"email\": \"walsh.porsche@ritchiemccullough.us\",\n \"email-authenticatable\": false,\n \"email-blocked-until\": null,\n \"first-name\": \"Porsche\",\n \"global-role\": null,\n \"insurance-num\": null,\n \"invitation-email-sent-at\": \"2025-07-01T00:02:15.511Z\",\n \"invite-id\": null,\n \"is-active\": true,\n \"is-local\": true,\n \"join-company-at\": null,\n \"labor-hours-start\": \"07:30:00\",\n \"last-invited-archived-at\": null,\n \"last-name\": \"Walsh\",\n \"locale\": \"en\",\n \"metadata\": {},\n \"password-changed-at\": null,\n \"payroll-num\": null,\n \"phone-num\": \"+5212390073006\",\n \"picture-url\": \"http://localhost:3000/uploads/prysmex/1/no_id/pictures/user_male_9fa8e66a-b133-4259-8ddd-f553ba1aefdd.jpg\",\n \"position\": null,\n \"privacy-accepted-date\": null,\n \"seat-type\": \"full\",\n \"send-notifications-by-email\": true,\n \"send-weekly-summary-by-email\": true,\n \"sign-in-count\": 0,\n \"support-client-subdomains\": [],\n \"time-zone\": null,\n \"updated-at\": \"2025-07-01T00:02:15.525Z\",\n \"username\": \"porsche_walsh\",\n \"working-regime\": \"moderate\"\n },\n \"relationships\": {\n \"created-by\": {\n \"data\": {\n \"id\": \"1\",\n \"type\": \"users\"\n }\n },\n \"last-invited-archived-by\": {\n \"data\": null\n },\n \"last-updated-by\": {\n \"data\": null\n },\n \"projects\": {\n \"data\": [\n {\n \"id\": \"2\",\n \"type\": \"projects\"\n },\n {\n \"id\": \"1\",\n \"type\": \"projects\"\n }\n ]\n },\n \"role\": {\n \"data\": {\n \"id\": \"4\",\n \"type\": \"roles\"\n }\n },\n \"user-groups\": {\n \"data\": [\n {\n \"id\": \"3\",\n \"type\": \"user-groups\"\n },\n {\n \"id\": \"2\",\n \"type\": \"user-groups\"\n }\n ]\n },\n \"zones\": {\n \"data\": [\n {\n \"id\": \"2\",\n \"type\": \"zones\"\n },\n {\n \"id\": \"19\",\n \"type\": \"zones\"\n }\n ]\n }\n }\n },\n {\n \"id\": \"10\",\n \"type\": \"users\",\n \"attributes\": {\n \"accepted-at\": \"2025-07-01T00:02:13.241Z\",\n \"archived-at\": null,\n \"auto-archives-at\": null,\n \"birth-date\": \"2004-07-01\",\n \"blood-type\": null,\n \"client-id\": 1,\n \"confirmation-sent-at\": \"2025-07-01T00:02:15.716Z\",\n \"confirmed-at\": null,\n \"contract-type\": \"employee\",\n \"country\": \"Bermuda\",\n \"created-at\": \"2025-07-01T00:02:13.252Z\",\n \"created-by-id\": 1,\n \"current-sign-in-at\": null,\n \"current-sign-in-ip\": null,\n \"date-format\": \"LL\",\n \"date-time-format\": \"lll\",\n \"document\": {},\n \"email\": \"beer.gayle@mitchell.biz\",\n \"email-authenticatable\": false,\n \"email-blocked-until\": null,\n \"first-name\": \"Gayle\",\n \"global-role\": null,\n \"insurance-num\": null,\n \"invitation-email-sent-at\": \"2025-07-01T00:02:15.716Z\",\n \"invite-id\": null,\n \"is-active\": true,\n \"is-local\": true,\n \"join-company-at\": null,\n \"labor-hours-start\": \"07:30:00\",\n \"last-invited-archived-at\": null,\n \"last-name\": \"Beer\",\n \"locale\": \"es\",\n \"metadata\": {},\n \"password-changed-at\": null,\n \"payroll-num\": null,\n \"phone-num\": \"+5217592891542\",\n \"picture-url\": \"http://localhost:3000/uploads/prysmex/1/no_id/pictures/user_female_7406b2c2-9044-4191-aa27-ed3522c622f4.jpg\",\n \"position\": null,\n \"privacy-accepted-date\": null,\n \"seat-type\": \"full\",\n \"send-notifications-by-email\": true,\n \"send-weekly-summary-by-email\": true,\n \"sign-in-count\": 0,\n \"support-client-subdomains\": [],\n \"time-zone\": null,\n \"updated-at\": \"2025-07-01T00:02:15.723Z\",\n \"username\": \"gayle_beer\",\n \"working-regime\": \"moderate\"\n },\n \"relationships\": {\n \"created-by\": {\n \"data\": {\n \"id\": \"1\",\n \"type\": \"users\"\n }\n },\n \"last-invited-archived-by\": {\n \"data\": null\n },\n \"last-updated-by\": {\n \"data\": null\n },\n \"projects\": {\n \"data\": [\n {\n \"id\": \"2\",\n \"type\": \"projects\"\n },\n {\n \"id\": \"1\",\n \"type\": \"projects\"\n }\n ]\n },\n \"role\": {\n \"data\": {\n \"id\": \"4\",\n \"type\": \"roles\"\n }\n },\n \"user-groups\": {\n \"data\": [\n {\n \"id\": \"2\",\n \"type\": \"user-groups\"\n },\n {\n \"id\": \"5\",\n \"type\": \"user-groups\"\n }\n ]\n },\n \"zones\": {\n \"data\": [\n {\n \"id\": \"18\",\n \"type\": \"zones\"\n }\n ]\n }\n }\n },\n {\n \"id\": \"11\",\n \"type\": \"users\",\n \"attributes\": {\n \"accepted-at\": \"2025-07-01T00:02:13.282Z\",\n \"archived-at\": null,\n \"auto-archives-at\": null,\n \"birth-date\": \"2004-07-01\",\n \"blood-type\": null,\n \"client-id\": 1,\n \"confirmation-sent-at\": \"2025-07-01T00:02:15.835Z\",\n \"confirmed-at\": null,\n \"contract-type\": \"employee\",\n \"country\": \"Panama\",\n \"created-at\": \"2025-07-01T00:02:13.296Z\",\n \"created-by-id\": 1,\n \"current-sign-in-at\": null,\n \"current-sign-in-ip\": null,\n \"date-format\": \"MM-DD-YYYY\",\n \"date-time-format\": \"lll\",\n \"document\": {},\n \"email\": \"lynch.edgardo@collier.ca\",\n \"email-authenticatable\": false,\n \"email-blocked-until\": null,\n \"first-name\": \"Edgardo\",\n \"global-role\": null,\n \"insurance-num\": null,\n \"invitation-email-sent-at\": \"2025-07-01T00:02:15.835Z\",\n \"invite-id\": null,\n \"is-active\": true,\n \"is-local\": true,\n \"join-company-at\": null,\n \"labor-hours-start\": \"07:30:00\",\n \"last-invited-archived-at\": null,\n \"last-name\": \"Lynch\",\n \"locale\": \"en\",\n \"metadata\": {},\n \"password-changed-at\": null,\n \"payroll-num\": null,\n \"phone-num\": \"+5213338585609\",\n \"picture-url\": \"http://localhost:3000/uploads/prysmex/1/no_id/pictures/user_male_2c54397f-d697-451e-a47c-de9dc6585fab.jpg\",\n \"position\": null,\n \"privacy-accepted-date\": null,\n \"seat-type\": \"full\",\n \"send-notifications-by-email\": true,\n \"send-weekly-summary-by-email\": true,\n \"sign-in-count\": 0,\n \"support-client-subdomains\": [],\n \"time-zone\": null,\n \"updated-at\": \"2025-07-01T00:02:15.868Z\",\n \"username\": \"edgardo_lynch\",\n \"working-regime\": \"moderate\"\n },\n \"relationships\": {\n \"created-by\": {\n \"data\": {\n \"id\": \"1\",\n \"type\": \"users\"\n }\n },\n \"last-invited-archived-by\": {\n \"data\": null\n },\n \"last-updated-by\": {\n \"data\": null\n },\n \"projects\": {\n \"data\": [\n {\n \"id\": \"2\",\n \"type\": \"projects\"\n },\n {\n \"id\": \"1\",\n \"type\": \"projects\"\n }\n ]\n },\n \"role\": {\n \"data\": {\n \"id\": \"3\",\n \"type\": \"roles\"\n }\n },\n \"user-groups\": {\n \"data\": []\n },\n \"zones\": {\n \"data\": []\n }\n }\n }\n ],\n \"included\": [\n {\n \"id\": \"5\",\n \"type\": \"user-groups\",\n \"attributes\": {\n \"client-id\": 1,\n \"created-at\": \"2025-07-01T00:02:12.898Z\",\n \"created-by-id\": 1,\n \"description\": \"Fuga dicta assumenda animi facilis.\",\n \"name\": \"Schoen and Sons\",\n \"picture-url\": \"http://localhost:3000/uploads/prysmex/1/no_id/pictures/prysmex-logo_d797f520-b001-4387-a663-6589f843c0d5.png\",\n \"updated-at\": \"2025-07-01T00:02:12.898Z\"\n },\n \"relationships\": {\n \"created-by\": {\n \"data\": {\n \"id\": \"1\",\n \"type\": \"users\"\n }\n },\n \"last-updated-by\": {\n \"data\": null\n }\n }\n },\n {\n \"id\": \"3\",\n \"type\": \"user-groups\",\n \"attributes\": {\n \"client-id\": 1,\n \"created-at\": \"2025-07-01T00:02:12.838Z\",\n \"created-by-id\": 1,\n \"description\": \"Ea dignissimos earum eos veritatis molestiae.\",\n \"name\": \"Larkin Inc\",\n \"picture-url\": \"http://localhost:3000/uploads/prysmex/1/no_id/pictures/prysmex-logo_a01a03fd-1ad7-414b-b4f7-c750f408507a.png\",\n \"updated-at\": \"2025-07-01T00:02:12.838Z\"\n },\n \"relationships\": {\n \"created-by\": {\n \"data\": {\n \"id\": \"1\",\n \"type\": \"users\"\n }\n },\n \"last-updated-by\": {\n \"data\": null\n }\n }\n },\n {\n \"id\": \"4\",\n \"type\": \"user-groups\",\n \"attributes\": {\n \"client-id\": 1,\n \"created-at\": \"2025-07-01T00:02:12.853Z\",\n \"created-by-id\": 1,\n \"description\": \"Inventore totam ut ratione pariatur.\",\n \"name\": \"Paucek, Dicki and Jacobs\",\n \"picture-url\": \"http://localhost:3000/uploads/prysmex/1/no_id/pictures/prysmex-logo_cc4a6b41-b6f4-430b-ac09-995648adc552.png\",\n \"updated-at\": \"2025-07-01T00:02:12.853Z\"\n },\n \"relationships\": {\n \"created-by\": {\n \"data\": {\n \"id\": \"1\",\n \"type\": \"users\"\n }\n },\n \"last-updated-by\": {\n \"data\": null\n }\n }\n },\n {\n \"id\": \"1\",\n \"type\": \"user-groups\",\n \"attributes\": {\n \"client-id\": 1,\n \"created-at\": \"2025-07-01T00:02:12.792Z\",\n \"created-by-id\": 1,\n \"description\": \"Facilis dignissimos voluptatum expedita facere perferendis.\",\n \"name\": \"Lebsack-Funk\",\n \"picture-url\": \"http://localhost:3000/uploads/prysmex/1/no_id/pictures/prysmex-logo_483dae5a-1b25-41e8-9f07-edff0d0b00c9.png\",\n \"updated-at\": \"2025-07-01T00:02:12.792Z\"\n },\n \"relationships\": {\n \"created-by\": {\n \"data\": {\n \"id\": \"1\",\n \"type\": \"users\"\n }\n },\n \"last-updated-by\": {\n \"data\": null\n }\n }\n },\n {\n \"id\": \"2\",\n \"type\": \"user-groups\",\n \"attributes\": {\n \"client-id\": 1,\n \"created-at\": \"2025-07-01T00:02:12.804Z\",\n \"created-by-id\": 1,\n \"description\": \"Dolorum iste eos necessitatibus cumque quos soluta dolore.\",\n \"name\": \"Quitzon Group\",\n \"picture-url\": \"http://localhost:3000/uploads/prysmex/1/no_id/pictures/prysmex-logo_5a269989-cf35-4719-bbdc-0c354c1e0b72.png\",\n \"updated-at\": \"2025-07-01T00:02:12.804Z\"\n },\n \"relationships\": {\n \"created-by\": {\n \"data\": {\n \"id\": \"1\",\n \"type\": \"users\"\n }\n },\n \"last-updated-by\": {\n \"data\": null\n }\n }\n }\n ],\n \"meta\": {\n \"total_pages\": 3,\n \"total_count\": 22\n }\n}"}],"_postman_id":"ea3c39d1-f567-481a-b160-57b21dcd99de"},{"name":"basic","event":[{"listen":"test","script":{"id":"d03ba784-bd9d-4236-83fd-81a78a752d1e","exec":[""],"type":"text/javascript","packages":{}}}],"id":"78865a6a-c8a5-47c1-887c-554d0c579270","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n // \"with_current_project_id\": [\"2\"]\n}","options":{"raw":{"language":"json"}}},"url":"https://b.prysmex.com/api/users/basic/search","description":"

Allows you to search for all users in the database, renders limited data for privacy.

Display sessions for the current user.

Deletes a session, effectively logging out the user of that session.

This endpoint is meant to be used internally (private)

Renders a specific user by id

Updates a user. When updating a user, only the attributes and relationships that are present in the request will be updated.

If a user is updating a local user, it can update all of its data. When updating a non-local user you can only update space specific data.

Deletes an account permanently. This cannot be done if the user owns any Space(s).

Archives a user from the current Space.

Unarchives a user from the current Space.

Endpoint that allows a user to update itself regardless of its role.

If you update your password, all oauth refresh tokens will expire and your devices will log out as soon as the access token expires.

Allows a user to update its own password and without the need for re-logging in on the current device. Other devices will be logged out when their access token expires since changing the password disables all oauth refresh tokens.

This endpoint is meant to be used internally (private)

Displays the latest non-accepted privacy policy.

This endpoint is meant to be used internally (private)

Accept the latest privacy notice

Attributes

🌎 Global user data

📤 Settable

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Default	Description
birth_date	date	null	User's date of birth
country	string	null	Country of residence
first_name*	string		User's first name
last_name	string	null	User's last name
email	string		User's email address
locale*	integer	`0`	Locale/language preference { 'es' => 0, 'en' => 1 }
phone_num	string		User's phone number
username	string		Unique username
send_notifications_by_email*	boolean	`true`	Whether the user receives notifications
time_zone	string		Preferred time zone
date_format*	string	`\"DD/MM/YYYY\"`	Preferred date format
date_time_format*	string	`\"lll\"`	Preferred date-time format
send_weekly_summary_by_email*	boolean	`true`	Whether to send weekly summary emails
labor_hours_start	time		Start time for labor hours tracking

🔒 System managed

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Default	Description
reset_password_sent_at	datetime		When password reset email was sent
sign_in_count*	integer	`0`	Number of times the user has signed in
current_sign_in_at	datetime		Timestamp of the most recent sign-in
current_sign_in_ip	inet		IP address used during most recent sign-in
is_active*	boolean	`true`	Whether the user can login
privacy_accepted_date	datetime		Date when privacy terms were accepted
password_changed_at	datetime		Timestamp of the most recent password change
is_local*	boolean	`true`	Whether admins have full control of the user
confirmed_at	datetime		When the user confirmed their email
confirmation_sent_at	datetime		When the confirmation email was sent
email_authenticatable*	boolean	`true`	Whether the user authenticates by email
metadata*	json	`{}`	Key-value pair with internal data
email_blocked_until	datetime		Block email sending until this time

See Common Attributes

📁 Space specific user data

📤 Settable

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Default	Description
role_id*	integer		ID of the Role assigned to the user in the space
working_regime	integer		{ 'light' => 0, 'moderate' => 1, 'heavy' => 2 }
insurance_num	string
blood_type	integer		{ 'a-' => 0, 'a+' => 1, 'b-' => 2, 'b+' => 3, 'ab+' => 4, 'ab-' => 5, 'o+' => 6, 'o-' => 7 }
join_company_at	date
contract_type	integer	`0`	{ 'employee' => 0, 'external_fixed' => 1, 'external_variable' => 2, 'unionized' => 3 }
position	string
payroll_num	string
auto_archives_at	datetime
document*	json	`{}`	Key-value data that must comply with the User schema

🔒 System managed

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
seat_type*	integer	The seat type associated with the role (system-managed) { 'free' => 0, 'full' => 1, 'support' => 2 }
accepted_at	datetime	Timestamp of when the user accepted the space invitation (system-managed)
archived_at	datetime	Timestamp of when the user was archived (system-managed)
invitation_email_sent_at	datetime	When the invitation email was sent (system-managed)
invite_id	integer	ID of invite if the user joined via one (system-managed)

See Common Attributes

🔗 Relationships

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description
`role`	Role	The Role of the user in the current space
`owned_clients`	Client[]	Clients owned by the user
`clients_users`	Client[]	Clients where the user has related data
`user_groups`	UserGroup[]	The UserGroups of the user in the current space

","_postman_id":"71968a20-683c-4502-8c43-1cc2dabd2eaa","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","name":"Authenticated endpoints","type":"folder"}}},{"name":"Roles","item":[{"name":"create","event":[{"listen":"test","script":{"id":"b1901281-4673-4b3a-a2d6-9c1790fb3f0a","exec":["pm.environment.set(\"_role_id\", pm.response.json().data.id);"],"type":"text/javascript","packages":{}}}],"id":"00a59752-73ee-414b-8490-440e131db0d0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"roles\",\n \"attributes\": {\n \"name-translations\": {\n \"es\": \"Colaborador de equipo\",\n \"en\": \"Team collaborator\"\n },\n \"description\": \"Et iure ipsa tenetur omnis error eum officia est.\",\n \"authenticatable\": true,\n \"special_role_type\": \"free\",\n \"authorizations-config\": {}\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://b.prysmex.com/api/roles","description":"

Use this endpoint to create a Role.

Use this endpoint to search for all Roles you are authorized to view. You can filter results using any of the attributes defined in the Role Data Model.

Additional filtering attributes

users_count

Use this endpoint to fetch a Role by id.

Use this endpoint to update a Role.

Use this endpoint to migrate al Users from an origin Role to a target Role.

Attributes

Data Model

The following tables describe the attributes available for this model, divided into two categories: 📤 API-settable and 🔒 System-managed attributes.

📤 Settable

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Default	Description
special_role_type	integer		{ 'global_admin' => 1, 'prysmex' => 2, 'support' => 3, 'free' => 4 }
name_translations*	json
description	text
authorizations_config*	jsonb	`{}`
authenticatable*	boolean	`true`

🔒 System managed

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Default	Description
client_id*	integer

See Common Attributes

🔗 Relationships

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description

","_postman_id":"6335a78f-2d53-4b75-bad0-8f44f15aeeea","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","name":"Authenticated endpoints","type":"folder"}}},{"name":"User groups","item":[{"name":"create","event":[{"listen":"test","script":{"id":"5cfe49ac-f4b7-45bb-822e-c67d9408f5a3","exec":["pm.environment.set(\"_user_group_id\", pm.response.json().data.id);"],"type":"text/javascript","packages":{}}}],"id":"a8483ed4-3edd-4b51-96c4-0a18ab1ef1f3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"user-groups\",\n \"attributes\": {\n \"specialty\": \"similique dolorum molestiae\",\n \"description\": \"Sapiente rerum quas tempore quia id libero est.\",\n \"name\": \"Dickens - Prosacco\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://b.prysmex.com/api/user_groups","description":"

Use this endpoint to create a UserGroup.

Use this endpoint to search for all UserGroups you are authorized to view. You can filter results using any of the attributes defined in the UserGroup Data Model.

Use this endpoint to migrate al Users from an origin Role to a target Role.

Attributes

Data Model

The following tables describe the attributes available for this model, divided into two categories: 📤 API-settable and 🔒 System-managed attributes.

📤 Settable

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Default	Description
name*	text
description	text

🔒 System managed

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Default	Description
client_id*	integer

See Common Attributes

🔗 Relationships

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description

","_postman_id":"2ef0856c-2717-43aa-b053-eab3cf96358b","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","name":"Authenticated endpoints","type":"folder"}}},{"name":"ContractorType","item":[{"name":"create","event":[{"listen":"test","script":{"id":"5cfe49ac-f4b7-45bb-822e-c67d9408f5a3","exec":["pm.environment.set(\"_contractor_type_id\", pm.response.json().data.id);"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"abaee50c-e015-44c3-9f98-15b947866063","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"contractor-types\",\n \"attributes\": {\n \"name-translations\": {\n \"es\": \"Foo\",\n \"en\": \"Foo\"\n },\n \"description\": \"Neque quibusdam maxime et aut.\"\n },\n \"relationships\": {\n \"company-schema-template\": {\n \"data\": {\n \"id\": 1,\n \"type\": \"company-schema-templates\"\n }\n }\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://b.prysmex.com/api/contractor_types","description":"

Use this endpoint to create a UserGroup.

Use this endpoint to search for all UserGroups you are authorized to view. You can filter results using any of the attributes defined in the UserGroup Data Model.

Attributes

Data Model

The following tables describe the attributes available for this model, divided into two categories: 📤 API-settable and 🔒 System-managed attributes.

📤 Settable

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Default	Description
name*	text
description	text

🔒 System managed

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Default	Description
client_id*	integer

See Common Attributes

🔗 Relationships

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description

","_postman_id":"90e79aa6-047e-4864-a451-323cbad9ae98","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","name":"Authenticated endpoints","type":"folder"}}},{"name":"ApiKey","item":[{"name":"create","event":[{"listen":"test","script":{"id":"5cfe49ac-f4b7-45bb-822e-c67d9408f5a3","exec":["pm.environment.set(\"_api_key_id\", pm.response.json().data.id);"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"22b7f268-d510-4233-95f2-cb12ab273f1a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"api-keys\",\n \"attributes\": {\n \"name\": \"My api key\",\n \"description\": \"Ea soluta voluptatum dicta in labore vel illum totam.\",\n \"expires-at\": \"2027-04-17T17:34:38-06:00\"\n },\n \"relationships\": {\n \"user\": {\n \"data\": {\n \"id\": 1,\n \"type\": \"users\"\n }\n }\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://b.prysmex.com/api/api_keys","description":"

Use this endpoint to create a UserGroup.

Use this endpoint to search for all UserGroups you are authorized to view. You can filter results using any of the attributes defined in the UserGroup Data Model.

Attributes

Data Model

The following tables describe the attributes available for this model, divided into two categories: 📤 API-settable and 🔒 System-managed attributes.

📤 Settable

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Default	Description
name*	text
description	text

🔒 System managed

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Default	Description
client_id*	integer

See Common Attributes

🔗 Relationships

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description

","_postman_id":"44e6bdc2-38cb-42bd-8b8e-3e8bd5a3c97d","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","name":"Authenticated endpoints","type":"folder"}}},{"name":"CertificateRequirementGroup","item":[{"name":"create","event":[{"listen":"test","script":{"id":"5cfe49ac-f4b7-45bb-822e-c67d9408f5a3","exec":["pm.environment.set(\"_certificate_requirement_group_id\", pm.response.json().data.id);"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"6b155149-bedb-451a-9412-bcd0264e1dea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"audience-search-state\": [],\n \"name-translations\": {\n \"en\": \"Group 1\",\n \"es\": \"Grupo 1\"\n }\n },\n \"type\": \"certificate-requirement-groups\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://b.prysmex.com/api/certificate_requirement_groups","description":"

Use this endpoint to create a UserGroup.

Use this endpoint to search for all UserGroups you are authorized to view. You can filter results using any of the attributes defined in the UserGroup Data Model.

Attributes

Data Model

The following tables describe the attributes available for this model, divided into two categories: 📤 API-settable and 🔒 System-managed attributes.

📤 Settable

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Default	Description
name*	text
description	text

🔒 System managed

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Default	Description
client_id*	integer

See Common Attributes

🔗 Relationships

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description

","_postman_id":"9379e1bd-60d4-43fe-8bcb-548089fb571e","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","name":"Authenticated endpoints","type":"folder"}}},{"name":"CertificateGoal","item":[{"name":"create","event":[{"listen":"test","script":{"id":"5cfe49ac-f4b7-45bb-822e-c67d9408f5a3","exec":["pm.environment.set(\"_certificate_goal_id\", pm.response.json().data.id);"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"0a5eb25e-9053-4845-8935-196861342cae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"model_type\": \"User\",\n \"name-translations\": {\n \"en\": \"Goal 1\",\n \"es\": \"Meta 1\"\n }\n },\n \"type\": \"certificate-goals\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://b.prysmex.com/api/certificate_goals","description":"

Use this endpoint to create a UserGroup.

Use this endpoint to search for all UserGroups you are authorized to view. You can filter results using any of the attributes defined in the UserGroup Data Model.

Attributes

Data Model

The following tables describe the attributes available for this model, divided into two categories: 📤 API-settable and 🔒 System-managed attributes.

📤 Settable

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Default	Description
name*	text
description	text

🔒 System managed

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Default	Description
client_id*	integer

See Common Attributes

🔗 Relationships

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description

","_postman_id":"2d7e0c79-77ea-4e4c-ba17-f2597b17ffd9","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","name":"Authenticated endpoints","type":"folder"}}},{"name":"Projects","item":[{"name":"create","event":[{"listen":"test","script":{"id":"7d351c89-0e5c-4982-9be7-ed8c8a614e48","exec":["pm.environment.set(\"_project_id\", pm.response.json().data.id);"],"type":"text/javascript","packages":{}}}],"id":"230f9369-9e35-4245-997d-8b5c165610a6","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"projects\",\n \"attributes\": {\n \"name\": \"Project6\",\n \"view-latitude\": 25,\n \"view-longitude\": -100,\n \"bearing\": 60,\n \"pitch\": 40,\n \"location\": {\n \"coordinates\": [\n [\n [\n -100.00042769584782,\n 25.00067678035589\n ],\n [\n -99.99945861779635,\n 25.000482887181832\n ],\n [\n -99.99939720301936,\n 24.999376608546243\n ],\n [\n -100.00062820396661,\n 24.999376608546243\n ],\n [\n -100.00042769584782,\n 25.00067678035589\n ]\n ]\n ],\n \"type\": \"Polygon\"\n },\n \"time-zone\": \"America/Monterrey\",\n \"picture-url\": null\n },\n \"relationships\": {\n // \"business-segment\": {\n // \"data\": {\n // \"id\": 1,\n // \"type\": \"business-segments\"\n // }\n // }\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://b.prysmex.com/api/projects","description":"

Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value
name *	string
alias *	string
view-latitude *	double
view-longitude *	double
bearing *	float
pitch *	float
location *	json
time-zone	enum { \"America/Anchorage\", \"America/Cancun\", \"America/Chicago\", \"America/Mexico_City\", \"America/Denver\", \"America/Edmonton\", \"America/Ensenada\", \"America/Guatemala\", \"America/Hermosillo\", \"America/Los_Angeles\", \"Europe/Madrid\", \"America/Merida\", \"America/Monterrey\", \"America/Montevideo\", \"America/Montreal\", \"America/New_York\", \"America/Santiago\", \"America/Sao_Paulo\", \"America/Thule\", \"America/Tijuana\", \"UTC\", \"America/Vancouver\", }
picture-url	string

Relationships

business_segment

*Required

lists all permitted projects.

get a project with a specified id

The published dataset that is visible on the project map

The draft dataset that is visible on the map builder

Publishes the tilesets for the users to see on the map by setting drafted_tilesets to published_tilesets

Attributes

Data Model

The following tables describe the attributes available for this model, divided into two categories: 📤 API-settable and 🔒 System-managed attributes.

📤 Settable

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Default	Description
view_longitude*	float		Longitud for initial display on map
view_latitude*	float		Latitud for initial display on map
name*	string		must be unique per Space
bearing	float		Bearing angle used for initial display on map
business_segment_id	integer		Id of the `BusinessSegment` it belongs to
location*	jsonb		Geojson that delimitates the area users location will be tracked
time_zone	string
pitch*	float	`40.0`	Pitch angle used for initial display on map
can_pitch_map*	boolean	`true`
published_tilesets	string[]	`[]`
drafted_tilesets	string[]	`[]`
mapping_tileset	string
zoom*	float	`17.0`	Zoom used for initial display on map

🔒 System managed

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Default	Description
client_id*	integer		Id of the `Client` it belongs to

See Common Attributes

🔗 Relationships

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description

","_postman_id":"aedf9ea0-fb7d-4c75-a07a-81291116eccf","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","name":"Authenticated endpoints","type":"folder"}}},{"name":"Zones","item":[{"name":"create","event":[{"listen":"test","script":{"id":"b52fe707-a17c-4a5b-95b9-8a915b2d0669","exec":["pm.environment.set(\"_zone_id\", pm.response.json().data.id);"],"type":"text/javascript"}}],"id":"1581e45c-6198-4657-9cc5-140e38a80ce1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"zones\",\n \"attributes\": {\n \"name\": \"Area 85\",\n \"location\": {\n \"type\": \"Polygon\",\n \"coordinates\": [\n [\n [\n -1.6907254698260772,\n 42.17756010836041\n ],\n [\n -1.6909237297190032,\n 42.17762755240864\n ],\n [\n -1.6908774812268632,\n 42.17770316529865\n ],\n [\n -1.690683077041399,\n 42.1776354378506\n ],\n [\n -1.6907254698260772,\n 42.17756010836041\n ]\n ]\n ]\n },\n \"is-hazardous\": false,\n \"interior\": true,\n \"natural-ventilation\": false,\n \"moving-machinery\": false,\n \"light-reflection-index\": 5\n },\n \"relationships\": {\n \"project\": {\n \"data\": {\n \"id\": {{project_id}},\n \"type\": \"projects\"\n }\n }//,\n // \"users\": {\n // \"data\": [\n // {\n // \"id\": 2,\n // \"type\": \"users\"\n // }\n // ]\n // }\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://b.prysmex.com/api/zones","description":"

Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value
name *	string
location *	json
is-hazardous	boolean
interior	boolean
natural-ventilation	boolean
moving-machinery	boolean
light-reflection-index	float

Relationships

project *
workers

*Required

Attributes

Data Model

The following tables describe the attributes available for this model, divided into two categories: 📤 API-settable and 🔒 System-managed attributes.

📤 Settable

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Default	Description
name*	string
location*	json		Geojson polygon
is_hazardous*	boolean	`false`
project_id	integer		Id of the `Project` it belongs to.
interior*	boolean	`false`
natural_ventilation*	boolean	`false`
moving_machinery*	boolean	`false`

🔒 System managed

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Default	Description
client_id*	integer		Id of the `Client` it belongs to

See Common Attributes

🔗 Relationships

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description

","_postman_id":"6902d935-1f1c-4b31-bf3e-35783977c5b2","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","name":"Authenticated endpoints","type":"folder"}}},{"name":"Shared schema templates","item":[{"name":"create","event":[{"listen":"test","script":{"id":"91c67650-1543-4ccc-a859-b04e8a678ae3","exec":["pm.environment.set(\"_shared_schema_templates_id\", pm.response.json().data.id);"],"type":"text/javascript"}}],"id":"fea94ae3-6be5-444c-a41a-c56d6df9f286","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"shared-schema-templates\",\n \"attributes\": {\n \"schema\": {\n \"title\": \"\",\n \"type\": \"object\",\n \"required\": [],\n \"properties\": {\n \"hello1928\": {\n \"$id\": \"#/properties/hello1928\",\n \"title\": \"hello1928\",\n \"type\": \"string\",\n \"displayProperties\": {\n \"component\": \"text_input\",\n \"i18n\": {\n \"label\": {\n \"es\": \"Hello\"\n }\n },\n \"visibility\": {\n \"label\": true\n },\n \"textarea\": true,\n \"pictures\": [],\n \"sort\": 0,\n \"hidden\": false\n },\n \"extra\": [\n \"reports\",\n \"notes\",\n \"pictures\"\n ]\n }\n }\n },\n \"name-translations\": {\n \"en\": \"Shared fields\",\n \"es\": \"Campos compartidos\"\n }\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://b.prysmex.com/api/shared_schema_templates","description":"

Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value
schema *	json
name-translations *	json

*Required

Data Model

The following tables describe the attributes available for this model, divided into two categories: 📤 API-settable and 🔒 System-managed attributes.

📤 Settable

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Default
name_translations*	json	{}
schema*	json	{}
description	text
tags	string[]	`[]`

🔒 System managed

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Default
client_id*	integer
schema_template_id	bigint
schema_search_helper*	json	{}
reserved*	boolean	`false`
available_locales	string[]	`[]`
property_name	string
published_at	datetime
unpublished_changes_at	datetime

See Common Attributes

\n","_postman_id":"4337da95-2dfb-40f3-8c1e-adf4fb4036a3","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","name":"Authenticated endpoints","type":"folder"}}},{"name":"Reports","item":[{"name":"create","event":[{"listen":"test","script":{"id":"56f29451-1a0d-4dc3-be7d-b67ebc19ee3e","exec":["pm.environment.set(\"_report_id\", pm.response.json().data.id);"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"ee5c6375-a866-4950-a1d7-0d0f8b0c81a9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"reports\",\n \"attributes\": {\n \"description\": \"Voluptatibus doloribus numquam quas.\",\n \"due-at\": \"2021-04-24T00:00:00.000Z\",\n \"savings\": 900.00,\n \"cost\": 300.00,\n \"currency\": null,\n \"priority\": \"high\",\n \"pictures-to-attach\": [],\n \"pictures-to-remove\": [],\n \"pictures_to_copy\": [],\n \"document\": {}\n },\n \"relationships\": {\n \"project\": {\n \"data\": {\n \"id\": 1,\n \"type\": \"projects\"\n }\n },\n // \"reviewer\": {\n // \"data\": {\n // \"id\": 61,\n // \"type\": \"users\"\n // }\n // },\n // \"visit\": {\n // \"data\": {\n // \"id\": 36,\n // \"type\": \"visits\"\n // }\n // },\n \"schema-template-version\": {\n \"data\": {\n \"id\": 6,\n \"type\": \"report-schema-templates\"\n }\n },\n // \"consequence\": {\n // \"data\": {\n // \"id\": {{consequence_id}},\n // \"type\": \"consequences\"\n // }\n // },\n // \"likelihood\": {\n // \"data\": {\n // \"id\": {{likelihood_id}},\n // \"type\": \"likelihoods\"\n // }\n // },\n \"users\": {\n \"data\": [\n {\n \"id\": 2,\n \"type\": \"users\"\n }\n ]\n },\n \"assigned-users\": {\n \"data\": [\n {\n \"id\": 2,\n \"type\": \"users\"\n }\n ]\n }\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://b.prysmex.com/api/reports","description":"

Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value
description *	string
latitude *	double
longitude *	double
occurrence-time	date
due-at	date
savings	float
cost	float
currency	enum { \"MXN\", \"USD\", \"EUR\" }
priority	enum { \"very_high\", \"high\", \"medium\", \"low\", \"very_low\" }
pictures-to-attach	array
pictures-to-remove	array
pictures-to-copy	array
document	json

Relationships

project *
schema-template-version *
reviewer
workers
assigned-workers
consequence
likelihood
zone
visit

*Required

Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value
description *	string
latitude *	double
longitude *	double
occurrence-time	date
due-at	date
savings	float
cost	float
currency	enum { \"MXN\", \"USD\", \"EUR\" }
priority	enum { \"very_high\", \"high\", \"medium\", \"low\", \"very_low\" }
pictures-to-attach	array
pictures-to-remove	array
pictures-to-copy	array
document	json

Relationships

project *
schema-template-version *
reviewer
workers
assigned-workers
consequence
likelihood
zone
visit

*Required

Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value
name-translations *	json
schema *	json
icon	string
icon-color	string

*Required

For filter examples see search_reports request.

Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value
document *	json

Relationships

project *
schema-template-version *
visit
required-by-report

*Required

Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value
name-translations *	json
schema *	json
icon	string
icon-color	string

*Required

Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value
description *	string
tag *	enum { \"productivity\", \"safety\", \"complete_ppe\", \"3_point_rule\", \"puntuality\", \"order_and_cleaning\", \"innovation\", \"teamwork\", \"other\" }
pictures-to-attach	array
pictures-to-remove	array
pictures-to-copy	array

Relationships

project *
workers
visit

*Required

Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value
description *	string
tag *	enum { \"productivity\", \"safety\", \"complete_ppe\", \"3_point_rule\", \"puntuality\", \"order_and_cleaning\", \"innovation\", \"teamwork\", \"other\" }
pictures-to-attach	array
pictures-to-remove	array
pictures-to-copy	array

Relationships

project *
workers
visit

*Required

Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value
description *	string
tag *	enum { \"productivity\", \"safety\", \"complete_ppe\", \"3_point_rule\", \"puntuality\", \"order_and_cleaning\", \"innovation\", \"teamwork\", \"other\" }
pictures-to-attach	array
pictures-to-remove	array
pictures-to-copy	array

Relationships

project *
workers
visit

*Required

Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value
intervals *	array

Relationships

project *
worker-position *
classification *

Included

Reports
Inspections
Recognitions

*Required

Use this endpoint to create a UserGroup.

This model represents a folder in the DriveNode data model.

Attributes

Data Model

The following tables describe the attributes available for this model, divided into two categories: 📤 API-settable and 🔒 System-managed attributes.

📤 Settable

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
name*	text
description	text
namespace	text
directory_id	uuid	parent folder id

🔒 System managed

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Default	Description
client_id*	integer

See Common Attributes

🔗 Relationships

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description
directory	`DriveNode`	parent folder

","_postman_id":"eb396d9d-c4a9-43bf-af6a-b0eca9369b4e","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","name":"Authenticated endpoints","type":"folder"}}},{"name":"Drive node files","item":[{"name":"generate_write_signed_url","event":[{"listen":"test","script":{"id":"5cfe49ac-f4b7-45bb-822e-c67d9408f5a3","exec":[""],"type":"text/javascript","packages":{}}}],"id":"08653c51-5962-46ef-8845-845a58e34b29","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"filename\": \"my_image.png\"\n}","options":{"raw":{"language":"json"}}},"url":"https://b.prysmex.com/api/drive_nodes/generate_write_signed_url","description":"

Returns form data needed in the upload_file endpoint to actually upload the file.

Returns form data needed in the upload_file endpoint to actually upload the file. Since this signature allows for an arbitrary amount of files to be uploaded, it does not return a key form data field so you need to set a unique key in the upload_file request.

This endpoint is for uploading the file directly to our file repository backend. All form-data values are obtained with the generate_write_signed_url endpoint.

\n","urlObject":{"protocol":"https","path":["static-staging.prysmex.com"],"host":["s3","amazonaws","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"f0e75bcd-4364-405b-a128-f9186382d9f4"},{"name":"create","event":[{"listen":"test","script":{"id":"5cfe49ac-f4b7-45bb-822e-c67d9408f5a3","exec":["pm.environment.set(\"_drive_node_file_id\", pm.response.json().data.id);"],"type":"text/javascript","packages":{}}}],"id":"d9ec6d30-6c0e-42de-b027-6e56faa86fa5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"drive-nodes\",\n \"attributes\": {\n \"type\": \"DriveNodeDirectory\",\n \"name\": \"krona.m3a\",\n \"url\": \"\",\n \"namespace\": null,\n \"description\": \"Vero ipsum et sunt neque quia enim repudiandae.\"\n },\n \"relationships\": {\n // \"directory\": {\n // \"data\": null\n // }\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://b.prysmex.com/api/drive_nodes","description":"

This endpoint registers an uploaded file into the DriveNode model. It requires that you first obtain uploading credentials via thegenerate_write_signed_url endpoint and upload the file via the upload_file endpoint.

Attributes

Data Model

The following tables describe the attributes available for this model, divided into two categories: 📤 API-settable and 🔒 System-managed attributes.

📤 Settable

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Description
name*	text
description	text
directory_id	uuid	parent folder id

🔒 System managed

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Type	Default	Description
client_id*	integer

See Common Attributes

🔗 Relationships

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description
directory	`DriveNode`	parent folder

","_postman_id":"e6843a8a-3226-435f-83e7-428819a8a498","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","name":"Authenticated endpoints","type":"folder"}}},{"name":"show","event":[{"listen":"test","script":{"id":"81b4cf07-4654-4ef8-8f5c-4c77afa6ff24","exec":[""],"type":"text/javascript","packages":{}}}],"id":"60b9c2b0-bc73-4ec5-b117-5e8a4f783a2a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://b.prysmex.com/api/drive_nodes/:id","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","name":"Authenticated endpoints","type":"folder"}},"urlObject":{"path":["api","drive_nodes",":id"],"host":["https://b.prysmex.com"],"query":[],"variable":[{"type":"string","value":"","key":"id"}]}},"response":[],"_postman_id":"60b9c2b0-bc73-4ec5-b117-5e8a4f783a2a"},{"name":"index","event":[{"listen":"test","script":{"id":"10a5d28a-872e-4c84-8dbb-81c4501cb53a","exec":[""],"type":"text/javascript","packages":{}}}],"id":"2add84e8-5a02-4f24-b522-52c969da518e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://b.prysmex.com/api/drive_nodes","description":"

Use this endpoint to search for DriveNodes you are authorized to view. The api is designed to only return nodes directly on the specified directory_id query param. If the directory_id param is not present, root nodes will match., You can filter results using any of the attributes defined in the DriveNode Data Model.

Use this endpoint to migrate al Users from an origin Role to a target Role.

This is the backing model for both 📑 files and 📁 folders in the Dirve module.

\n","_postman_id":"20a1164a-e083-4313-bb6d-f090d226977f","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","name":"Authenticated endpoints","type":"folder"}}},{"name":"Classifications","item":[{"name":"create","event":[{"listen":"test","script":{"id":"88a568ae-fed2-4b3e-b3e1-6577e1c87f84","exec":["pm.environment.set(\"_classification_id\", pm.response.json().data.id);"],"type":"text/javascript"}}],"id":"2ee21610-4f66-4a22-81fd-d18962cf5372","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"classifications\",\n \"attributes\": {\n \"name-translations\": {\n \"en\": \"odit\",\n \"es\": \"quasi\"\n },\n \"subject-class\": \"Visit\",\n \"position\": 4\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://b.prysmex.com/api/classifications","description":"

Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value
name-translations *	json
subject-class *	enum { \"Visit\" }
position	int

*Required

Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value
name-translations *	json
subject-class *	enum { \"Visit\" }
position	int

*Required

Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value
name-translations *	json
subject-class *	enum { \"Visit\" }
position	int

*Required

Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value
name-translations *	json
schema *	json
icon	string
icon-color	string

*Required

Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value
description *	string
latitude *	double
longitude *	double
occurrence-time	date
due-at	date
savings	float
cost	float
currency	enum { \"MXN\", \"USD\", \"EUR\" }
priority	enum { \"very_high\", \"high\", \"medium\", \"low\", \"very_low\" }
pictures-to-attach	array
pictures-to-remove	array
pictures-to-copy	array
document	json

Relationships

project *
schema-template-version *
reviewer
workers
assigned-workers
consequence
likelihood
zone
visit

*Required

Returns a hash with the certificate status for a set of users.

Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value
name-translations *	json
schema *	json
icon	string
icon-color	string

*Required

Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value
name-translations *	json
schema *	json
icon	string
icon-color	string

*Required

Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value
title *	string
description *	string
tags	array
pictures-to-attach	array
pictures-to-remove	array
pictures-to-copy	array

Relationships

project *
postable *

*Required

Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value
symbol-type *	string
identifier	string
latitude *	double
longitude *	double

Relationships

project *

*Required

Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value
alert-type *	string
alert-priority *	enum { \"low\", \"medium\", \"high\" }
latitude *	double
longitude *	double

Relationships

project *

*Required

Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value
title *	string
description *	string
tags	array
pictures-to-attach	array
pictures-to-remove	array
pictures-to-copy	array

Relationships

project *
postable *

*Required

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","name":"Authenticated endpoints","type":"folder"}},"urlObject":{"path":["api","posts"],"host":["https://b.prysmex.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"051e1cdf-0c5c-4b32-b584-05d11efafc6e"},{"name":"update","id":"ae907355-cb23-44a4-98b4-a41dcf7170c5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"posts\",\n \"attributes\": {\n \"description\": \"Update description\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://b.prysmex.com/api/posts/:id","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","name":"Authenticated endpoints","type":"folder"}},"urlObject":{"path":["api","posts",":id"],"host":["https://b.prysmex.com"],"query":[],"variable":[{"id":"03d97c89-dabb-4264-a47f-cf27d4c7cb4d","type":"any","value":"{{post_id}}","key":"id"}]}},"response":[],"_postman_id":"ae907355-cb23-44a4-98b4-a41dcf7170c5"},{"name":"destroy","id":"9a40d55d-4117-4358-a93b-28faea5a41af","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://b.prysmex.com/api/posts/:id","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","name":"Authenticated endpoints","type":"folder"}},"urlObject":{"path":["api","posts",":id"],"host":["https://b.prysmex.com"],"query":[],"variable":[{"id":"7c9df465-af32-4951-b02d-9470c21d130f","type":"any","value":"{{post_id}}","key":"id"}]}},"response":[],"_postman_id":"9a40d55d-4117-4358-a93b-28faea5a41af"},{"name":"get_comments","id":"648e7be2-43d0-4a8c-9fcb-e35330674b34","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://b.prysmex.com/api/posts/:id/get_comments","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","name":"Authenticated endpoints","type":"folder"}},"urlObject":{"path":["api","posts",":id","get_comments"],"host":["https://b.prysmex.com"],"query":[],"variable":[{"id":"c19422e4-c4ea-4fe3-a582-e4aedd4405b6","type":"any","value":"{{post_id}}","key":"id"}]}},"response":[],"_postman_id":"648e7be2-43d0-4a8c-9fcb-e35330674b34"},{"name":"add_comment","id":"b5d44b7e-69a5-4465-a6f5-fc6b4a18ec9f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"text\": \"Comment\",\n \"picture_url\": \"http://b-prysmex-dev.prysmex.com:3000/uploads/prysmex/1/no_id/pictures/unsafe_act_1_44c6af2b-63d5-4c3a-abbd-4b6d9d261aa7.jpg\"\n}","options":{"raw":{"language":"json"}}},"url":"https://b.prysmex.com/api/posts/:id/add_comment","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","name":"Authenticated endpoints","type":"folder"}},"urlObject":{"path":["api","posts",":id","add_comment"],"host":["https://b.prysmex.com"],"query":[],"variable":[{"id":"b49d2146-ab0f-43e9-a5db-d31cd5a4b3a4","type":"any","value":"{{post_id}}","key":"id"}]}},"response":[],"_postman_id":"b5d44b7e-69a5-4465-a6f5-fc6b4a18ec9f"},{"name":"get_reviews","id":"b899c843-23b1-4982-a6d4-5488eb410d8a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://b.prysmex.com/api/posts/:id/get_reviews","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","name":"Authenticated endpoints","type":"folder"}},"urlObject":{"path":["api","posts",":id","get_reviews"],"host":["https://b.prysmex.com"],"query":[],"variable":[{"id":"2aa4bac5-ea99-43bd-9b41-0c28a55cc8b9","type":"any","value":"{{post_id}}","key":"id"}]}},"response":[],"_postman_id":"b899c843-23b1-4982-a6d4-5488eb410d8a"},{"name":"add_review","id":"c3aedc03-de68-4aa4-aff2-f45a25203cdf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"comment\": \"Good post\",\n \"score\": 4\n}","options":{"raw":{"language":"json"}}},"url":"https://b.prysmex.com/api/posts/:id/add_review","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","name":"Authenticated endpoints","type":"folder"}},"urlObject":{"path":["api","posts",":id","add_review"],"host":["https://b.prysmex.com"],"query":[],"variable":[{"id":"e89e6439-2971-4454-a380-ddf226088864","type":"any","value":"{{post_id}}","key":"id"}]}},"response":[],"_postman_id":"c3aedc03-de68-4aa4-aff2-f45a25203cdf"}],"id":"db28c021-d892-417f-a93f-b9f8a4ed7378","_postman_id":"db28c021-d892-417f-a93f-b9f8a4ed7378","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","name":"Authenticated endpoints","type":"folder"}}},{"name":"Campaign messages","item":[{"name":"index","id":"69f7a7d9-3785-4947-954f-cafc28fb2bd6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://b.prysmex.com/api/campaign_messages","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","name":"Authenticated endpoints","type":"folder"}},"urlObject":{"path":["api","campaign_messages"],"host":["https://b.prysmex.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"69f7a7d9-3785-4947-954f-cafc28fb2bd6"},{"name":"show","id":"837f1b2e-b932-435b-8980-756c02816fbb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://b.prysmex.com/api/campaign_messages/:id","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","name":"Authenticated endpoints","type":"folder"}},"urlObject":{"path":["api","campaign_messages",":id"],"host":["https://b.prysmex.com"],"query":[],"variable":[{"id":"a4625493-86e1-46be-9fcb-49563e9ca7c0","type":"string","value":"{{campaign_message_id}}","key":"id"}]}},"response":[],"_postman_id":"837f1b2e-b932-435b-8980-756c02816fbb"},{"name":"create","event":[{"listen":"test","script":{"id":"f8955895-91d8-4613-bc42-c345949bbd37","exec":["pm.environment.set(\"campaign_message_id\", pm.response.json().data.id);","postman.setNextRequest(\"show_campaign_message\");"],"type":"text/javascript"}}],"id":"2fb660d3-9fde-47f5-8c94-3fc1b3287aac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"campaign-messages\",\n \"attributes\": {\n \"title\": \"Hello\",\n \"days-of-week\": [\n \"Tuesday\",\n \"Thursday\"\n ]\n },\n \"relationships\": {\n \"campaign\": {\n \"data\": {\n \"type\": \"campaigns\",\n \"id\": {{campaign_id}}\n }\n }\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://b.prysmex.com/api/campaign_messages","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","name":"Authenticated endpoints","type":"folder"}},"urlObject":{"path":["api","campaign_messages"],"host":["https://b.prysmex.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"2fb660d3-9fde-47f5-8c94-3fc1b3287aac"},{"name":"run","event":[{"listen":"test","script":{"id":"f8955895-91d8-4613-bc42-c345949bbd37","exec":[""],"type":"text/javascript","packages":{}}}],"id":"679590d8-6566-4635-9ab1-e129f2a6fc6c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://b.prysmex.com/api/campaign_messages/1/run","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","name":"Authenticated endpoints","type":"folder"}},"urlObject":{"path":["api","campaign_messages","1","run"],"host":["https://b.prysmex.com"],"query":[{"disabled":true,"key":"repeat_for_users_override","value":"true"}],"variable":[]}},"response":[],"_postman_id":"679590d8-6566-4635-9ab1-e129f2a6fc6c"},{"name":"update","id":"7a49b826-2370-44ab-ae40-3f1203c7b596","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"campaign-messages\",\n \"attributes\": {\n \"title\": \"Update message\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://b.prysmex.com/api/campaign_messages/:id","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","name":"Authenticated endpoints","type":"folder"}},"urlObject":{"path":["api","campaign_messages",":id"],"host":["https://b.prysmex.com"],"query":[],"variable":[{"id":"5edf75ab-d6a6-481a-93f6-098dd3a21c8d","type":"string","value":"{{campaign_message_id}}","key":"id"}]}},"response":[],"_postman_id":"7a49b826-2370-44ab-ae40-3f1203c7b596"},{"name":"destroy","id":"9454254c-2414-4b66-841c-e5522958d510","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://b.prysmex.com/api/campaign_messages/:id","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","name":"Authenticated endpoints","type":"folder"}},"urlObject":{"path":["api","campaign_messages",":id"],"host":["https://b.prysmex.com"],"query":[],"variable":[{"id":"5dbd254e-b54b-4332-adc9-4d88c27b22a1","type":"string","value":"{{campaign_message_id}}","key":"id"}]}},"response":[],"_postman_id":"9454254c-2414-4b66-841c-e5522958d510"},{"name":"mark_as_read","id":"d26b3d7d-d5cb-49de-b5b9-e51f445537f8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://b.prysmex.com/api/campaign_messages/:id/mark_as_read","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","name":"Authenticated endpoints","type":"folder"}},"urlObject":{"path":["api","campaign_messages",":id","mark_as_read"],"host":["https://b.prysmex.com"],"query":[],"variable":[{"id":"aeb17545-bd58-4907-9f93-18bbf47d26d0","type":"string","value":"{{campaign_message_id}}","key":"id"}]}},"response":[],"_postman_id":"d26b3d7d-d5cb-49de-b5b9-e51f445537f8"},{"name":"overview","id":"c5270903-e34e-4018-8990-aeaf5407d92b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://b.prysmex.com/api/campaign_messages/:id/data/overview","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","name":"Authenticated endpoints","type":"folder"}},"urlObject":{"path":["api","campaign_messages",":id","data","overview"],"host":["https://b.prysmex.com"],"query":[],"variable":[{"id":"099475ad-1fe2-441d-bc1e-b7128736bced","type":"string","value":"{{campaign_message_id}}","key":"id"}]}},"response":[],"_postman_id":"c5270903-e34e-4018-8990-aeaf5407d92b"},{"name":"interactions_chart","id":"7bea279d-9764-4b0c-9281-fc5e41d4c5c5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://b.prysmex.com/api/campaign_messages/:id/data/interactions_chart","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","name":"Authenticated endpoints","type":"folder"}},"urlObject":{"path":["api","campaign_messages",":id","data","interactions_chart"],"host":["https://b.prysmex.com"],"query":[],"variable":[{"id":"9f405489-892d-4bc9-af02-7b28ffc77090","type":"string","value":"{{campaign_message_id}}","key":"id"}]}},"response":[],"_postman_id":"7bea279d-9764-4b0c-9281-fc5e41d4c5c5"},{"name":"users_table","id":"34e7043b-d15f-4ff0-8212-e35ade46c7f0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://b.prysmex.com/api/campaign_messages/:id/data/users_table","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","name":"Authenticated endpoints","type":"folder"}},"urlObject":{"path":["api","campaign_messages",":id","data","users_table"],"host":["https://b.prysmex.com"],"query":[],"variable":[{"id":"d4a2cae0-4a71-4dca-8fca-2f478aa46246","type":"string","value":"{{campaign_message_id}}","key":"id"}]}},"response":[],"_postman_id":"34e7043b-d15f-4ff0-8212-e35ade46c7f0"}],"id":"1183b368-ebe0-4dc2-b6bb-2f6afe63c418","_postman_id":"1183b368-ebe0-4dc2-b6bb-2f6afe63c418","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","name":"Authenticated endpoints","type":"folder"}}},{"name":"Campaign messages users","item":[],"id":"bd862a42-9737-4dcc-8cae-f6db8d576b7a","_postman_id":"bd862a42-9737-4dcc-8cae-f6db8d576b7a","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","name":"Authenticated endpoints","type":"folder"}}},{"name":"Campaigns","item":[{"name":"index","event":[{"listen":"test","script":{"id":"9f53fe4a-c98e-4be5-a78d-d08baffbe608","exec":["postman.setNextRequest(\"create_campaign\");"],"type":"text/javascript"}}],"id":"e337ae16-ff59-4b73-9ca2-9dec9ae52944","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://b.prysmex.com/api/campaigns?per=5&page=1","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","name":"Authenticated endpoints","type":"folder"}},"urlObject":{"path":["api","campaigns"],"host":["https://b.prysmex.com"],"query":[{"key":"per","value":"5"},{"key":"page","value":"1"}],"variable":[]}},"response":[],"_postman_id":"e337ae16-ff59-4b73-9ca2-9dec9ae52944"},{"name":"show","event":[{"listen":"test","script":{"id":"8fde5493-0d3e-4dc0-9f58-e7371651edde","exec":["postman.setNextRequest(\"update_campaign\");"],"type":"text/javascript"}}],"id":"64f00e85-aa77-4c8d-978b-217f126cd94e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://b.prysmex.com/api/campaigns/:id","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","name":"Authenticated endpoints","type":"folder"}},"urlObject":{"path":["api","campaigns",":id"],"host":["https://b.prysmex.com"],"query":[],"variable":[{"id":"84487975-04fd-4a26-aedd-11c34e55680e","type":"string","value":"{{campaign_id}}","key":"id"}]}},"response":[],"_postman_id":"64f00e85-aa77-4c8d-978b-217f126cd94e"},{"name":"create","event":[{"listen":"test","script":{"id":"a17e387e-06d5-4ed4-8668-eeab00df67bb","exec":["pm.environment.set(\"campaign_id\", pm.response.json().data.id);","postman.setNextRequest(\"show_campaign\");"],"type":"text/javascript"}}],"id":"f63c97fd-3637-4758-9a01-a75c1a7fa6d3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"campaigns\",\n \"attributes\": {\n \"title\": \"New Campaign\",\n \"start-date\": \"2020-09-09T05:00:00.000Z\",\n \"end-date\": \"2021-09-10T05:00:00.000Z\",\n \"is-active\": true,\n \"days-of-week\": [\n \"Monday\",\n \"Tuesday\",\n \"Wednesday\",\n \"Thursday\",\n \"Friday\"\n ]\n },\n \"relationships\": {\n \"campaign-questions\": {\n \"data\": [\n {\n \"id\": \"{{campaign_question_id}}\",\n \"type\": \"campaign-questions\"\n }\n ]\n },\n \"campaign-messages\": {\n \"data\": [\n {\n \"id\": \"{{campaign_messages_id}}\",\n \"type\": \"campaign-messages\"\n }\n ]\n }\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://b.prysmex.com/api/campaigns","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","name":"Authenticated endpoints","type":"folder"}},"urlObject":{"path":["api","campaigns"],"host":["https://b.prysmex.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"f63c97fd-3637-4758-9a01-a75c1a7fa6d3"},{"name":"update","event":[{"listen":"test","script":{"id":"0f061b13-0baa-4e71-aa32-c77cd0ef2a91","exec":["postman.setNextRequest(\"destroy_campaign\");"],"type":"text/javascript"}}],"id":"193aa30b-ffc7-4757-9328-853856307648","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"campaigns\",\n \"attributes\": {\n \"end-date\": \"2021-09-15T05:00:00.000Z\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://b.prysmex.com/api/campaigns/:id","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","name":"Authenticated endpoints","type":"folder"}},"urlObject":{"path":["api","campaigns",":id"],"host":["https://b.prysmex.com"],"query":[],"variable":[{"id":"70e49fb8-3ec9-4d23-8e21-4aa619475c6f","type":"string","value":"{{campaign_id}}","key":"id"}]}},"response":[],"_postman_id":"193aa30b-ffc7-4757-9328-853856307648"},{"name":"destroy","id":"aed9dd2f-3520-433e-8f2f-6a7556051a2e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://b.prysmex.com/api/campaigns/:id","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","name":"Authenticated endpoints","type":"folder"}},"urlObject":{"path":["api","campaigns",":id"],"host":["https://b.prysmex.com"],"query":[],"variable":[{"id":"2c404d1a-3b77-4d24-ad32-d2f760db85e9","type":"string","value":"{{campaign_id}}","key":"id"}]}},"response":[],"_postman_id":"aed9dd2f-3520-433e-8f2f-6a7556051a2e"},{"name":"daily_pop_ups","event":[{"listen":"prerequest","script":{"id":"b3d87ff4-f1a3-4a92-aa96-3384f1d6deb3","exec":[""],"type":"text/javascript"}},{"listen":"test","script":{"id":"53f473e5-4cb6-4b01-9551-81d8a3f7ee64","exec":["postman.setNextRequest(\"bootstrap\");"],"type":"text/javascript"}}],"id":"0e347601-5581-4d12-9cd6-988190629192","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://b.prysmex.com/api/daily_pop_ups","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","name":"Authenticated endpoints","type":"folder"}},"urlObject":{"path":["api","daily_pop_ups"],"host":["https://b.prysmex.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"0e347601-5581-4d12-9cd6-988190629192"},{"name":"overview","id":"cc5bdfb7-964e-4c6e-9773-0d3c23729e4a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://b.prysmex.com/api/campaigns/:id/data/overview","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","name":"Authenticated endpoints","type":"folder"}},"urlObject":{"path":["api","campaigns",":id","data","overview"],"host":["https://b.prysmex.com"],"query":[],"variable":[{"id":"570f0f81-5d41-4b94-8631-2b0eab1f0ffe","type":"string","value":"{{campaign_id}}","key":"id"}]}},"response":[],"_postman_id":"cc5bdfb7-964e-4c6e-9773-0d3c23729e4a"},{"name":"users_table","id":"b4ceb750-7e9f-46d0-b9e6-a1f3398aaf57","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://b.prysmex.com/api/campaigns/:id/data/users_table","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","name":"Authenticated endpoints","type":"folder"}},"urlObject":{"path":["api","campaigns",":id","data","users_table"],"host":["https://b.prysmex.com"],"query":[],"variable":[{"id":"da84f9e9-f766-4172-82ab-34c52bd63636","type":"string","value":"{{campaign_id}}","key":"id"}]}},"response":[],"_postman_id":"b4ceb750-7e9f-46d0-b9e6-a1f3398aaf57"},{"name":"interactions_chart","id":"0e321bfa-3579-4e07-b898-d2107e5dbdd2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://b.prysmex.com/api/campaigns/:id/data/interactions_chart","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","name":"Authenticated endpoints","type":"folder"}},"urlObject":{"path":["api","campaigns",":id","data","interactions_chart"],"host":["https://b.prysmex.com"],"query":[],"variable":[{"id":"b743c749-1d46-48b8-951e-6308dfb8b57d","type":"string","value":"{{campaign_id}}","key":"id"}]}},"response":[],"_postman_id":"0e321bfa-3579-4e07-b898-d2107e5dbdd2"},{"name":"elements_table","id":"049c2ce8-b6bc-4dd4-ae82-cc88ea6d975b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://b.prysmex.com/api/campaigns/:id/data/elements_table","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","name":"Authenticated endpoints","type":"folder"}},"urlObject":{"path":["api","campaigns",":id","data","elements_table"],"host":["https://b.prysmex.com"],"query":[],"variable":[{"id":"59e7d047-20a2-4071-9594-b99cae65a1a0","type":"string","value":"{{campaign_id}}","key":"id"}]}},"response":[],"_postman_id":"049c2ce8-b6bc-4dd4-ae82-cc88ea6d975b"}],"id":"364fe25e-94b1-43fb-8552-454a0f4faff2","_postman_id":"364fe25e-94b1-43fb-8552-454a0f4faff2","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","name":"Authenticated endpoints","type":"folder"}}},{"name":"BusinessSegmentSchemaTemplates","item":[{"name":"index","event":[{"listen":"test","script":{"id":"d7fb62d7-a9b6-4282-8d12-e87c65874dc9","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"d66f9790-c6fa-4a7b-8fd4-9332d36bbf20","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://b.prysmex.com/api/business_segment_schema_templates","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","name":"Authenticated endpoints","type":"folder"}},"urlObject":{"path":["api","business_segment_schema_templates"],"host":["https://b.prysmex.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"d66f9790-c6fa-4a7b-8fd4-9332d36bbf20"},{"name":"show","event":[{"listen":"test","script":{"id":"b35f5465-93d2-4380-b0de-24887393bdcd","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"4857a614-00ad-4333-a26d-34c56704d7ee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://b.prysmex.com/api/business_segment_schema_templates/:id","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","name":"Authenticated endpoints","type":"folder"}},"urlObject":{"path":["api","business_segment_schema_templates",":id"],"host":["https://b.prysmex.com"],"query":[],"variable":[{"type":"string","value":"{{_business_segment_schema_template_id}}","key":"id"}]}},"response":[],"_postman_id":"4857a614-00ad-4333-a26d-34c56704d7ee"},{"name":"create","event":[{"listen":"test","script":{"id":"cd611b5f-c2dd-4493-8c66-a77aa335fc58","exec":["pm.environment.set(\"_business_segment_schema_template_id\", pm.response.json().data.id);"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"7ae0be4a-a305-4584-a1aa-b926d30d9239","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"business-segment-schema-templates\",\n \"attributes\": {\n \"name-translations\": {\n \"es\": \"México\",\n \"en\": \"México\"\n },\n \"schema\": {},\n \"description\": \"Some awesome description\"\n },\n \"relationships\": {\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://b.prysmex.com/api/business_segment_schema_templates","description":"

Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value
symbol-type *	string
identifier	string
latitude *	double
longitude *	double

Relationships

project *

*Required

Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value
symbol-type *	string
identifier	string
latitude *	double
longitude *	double

Relationships

project *

*Required

Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value
name *	string

*Required

Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value
name *	string

*Required

Use this endpoint to create a Role.

Use this endpoint to search for all Roles you are authorized to view. You can filter results using any of the attributes defined in the Role Data Model.

Additional filtering attributes

users_count

Use this endpoint to fetch a Role by id.

Use this endpoint to update a Role.

Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value
link-type *	enum { \"is_blocked_by\", \"blocks\", \"is_cloned_by\", \"clones\" \"is_duplicated_by\", \"duplicates\", \"is_caused_by\", \"causes\", \"relates_to\" }

Relationships

origin *
target *

*Required

Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value
endpoint *	string
sorting	json
query *	json
model-type *	string
label *	json
view-config	json
web-notification-subscribed	boolean
email-notification-subscribed	boolean
app-notification-subscribed	boolean
preload	boolean
section *	string
position	int

Relationships

project *

*Required

Set to true for 'unread notifications'

\n","type":"text/plain"},"key":"unread","value":"false"}],"variable":[]}},"response":[{"id":"91cc45ee-4425-4c4a-9585-9e60641c3a9b","name":"index_notifications","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://b.prysmex.com/api/notifications?page=1&unread=false","host":["https://b.prysmex.com"],"path":["api","notifications"],"query":[{"key":"page","value":"1"},{"key":"unread","value":"false","description":"Set to true for 'unread notifications'"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Content-Type","value":"application/vnd.api+json; charset=utf-8"},{"key":"ETag","value":"W/\"ae8951f67ef12184c7f0ac762ebfb55b\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"5b0dcab1-35b9-4796-8124-51b2bb83c0f2"},{"key":"X-Runtime","value":"0.749052"},{"key":"Vary","value":"Origin"},{"key":"Content-Length","value":"6960"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"939\",\n \"type\": \"notifications\",\n \"attributes\": {\n \"client-id\": 1,\n \"created-by-id\": 1,\n \"created-at\": \"2023-05-13T03:22:50.666Z\",\n \"updated-at\": \"2023-05-13T03:22:50.666Z\",\n \"read-at\": null,\n \"text\": \"report_was_closed\",\n \"text-params\": {\n \"report_description\": \"Sit ut aliquam minus blanditiis. Nisi corrupti perferendis qui ea placeat expedita. Inventore perferendis maiores facilis explicabo dolorem aspernatur suscipit.\",\n \"user_name\": \"Catherina Hegmann\",\n \"id\": 172\n },\n \"notifiable-type\": \"Report\",\n \"notifiable-id\": 172,\n \"schema-template-id\": 1\n },\n \"relationships\": {\n \"created-by\": {\n \"data\": {\n \"id\": \"1\",\n \"type\": \"users\"\n }\n },\n \"project\": {\n \"data\": {\n \"id\": \"2\",\n \"type\": \"projects\"\n }\n },\n \"user\": {\n \"data\": {\n \"id\": \"4\",\n \"type\": \"users\"\n }\n }\n }\n },\n {\n \"id\": \"931\",\n \"type\": \"notifications\",\n \"attributes\": {\n \"client-id\": 1,\n \"created-by-id\": 1,\n \"created-at\": \"2023-05-13T03:22:50.589Z\",\n \"updated-at\": \"2023-05-13T03:22:50.589Z\",\n \"read-at\": null,\n \"text\": \"report_was_closed\",\n \"text-params\": {\n \"report_description\": \"Libero officia pariatur tenetur vel. Quo nemo mollitia odit consectetur. Accusamus voluptatibus dignissimos nesciunt aperiam nemo. Aliquam nulla laboriosam suscipit possimus corporis. Illum quidem laboriosam non rerum quos voluptate perferendis.\",\n \"user_name\": \"Catherina Hegmann\",\n \"id\": 281\n },\n \"notifiable-type\": \"Report\",\n \"notifiable-id\": 281,\n \"schema-template-id\": 13\n },\n \"relationships\": {\n \"created-by\": {\n \"data\": {\n \"id\": \"1\",\n \"type\": \"users\"\n }\n },\n \"project\": {\n \"data\": {\n \"id\": \"2\",\n \"type\": \"projects\"\n }\n },\n \"user\": {\n \"data\": {\n \"id\": \"4\",\n \"type\": \"users\"\n }\n }\n }\n },\n {\n \"id\": \"914\",\n \"type\": \"notifications\",\n \"attributes\": {\n \"client-id\": 1,\n \"created-by-id\": 1,\n \"created-at\": \"2023-05-13T03:22:50.275Z\",\n \"updated-at\": \"2023-05-13T03:22:50.275Z\",\n \"read-at\": null,\n \"text\": \"report_was_closed\",\n \"text-params\": {\n \"report_description\": \"Quidem eos vitae vel ipsum necessitatibus cumque magnam animi. Magnam id modi iusto esse dolorum rerum reprehenderit. Error enim aliquam aspernatur debitis ut.\",\n \"user_name\": \"Catherina Hegmann\",\n \"id\": 278\n },\n \"notifiable-type\": \"Report\",\n \"notifiable-id\": 278,\n \"schema-template-id\": 13\n },\n \"relationships\": {\n \"created-by\": {\n \"data\": {\n \"id\": \"1\",\n \"type\": \"users\"\n }\n },\n \"project\": {\n \"data\": {\n \"id\": \"2\",\n \"type\": \"projects\"\n }\n },\n \"user\": {\n \"data\": {\n \"id\": \"4\",\n \"type\": \"users\"\n }\n }\n }\n },\n {\n \"id\": \"883\",\n \"type\": \"notifications\",\n \"attributes\": {\n \"client-id\": 1,\n \"created-by-id\": 1,\n \"created-at\": \"2023-05-13T03:22:49.882Z\",\n \"updated-at\": \"2023-05-13T03:22:49.882Z\",\n \"read-at\": null,\n \"text\": \"report_is_ready\",\n \"text-params\": {\n \"report_description\": \"Doloribus natus consequuntur aperiam nisi ipsum maxime. Placeat culpa accusamus adipisci dicta in laudantium tempora. Animi quo occaecati voluptates ad corrupti. Alias officia eos facere reprehenderit. Ullam molestiae ratione corrupti ad.\",\n \"user_name\": \"Catherina Hegmann\",\n \"id\": 230\n },\n \"notifiable-type\": \"Report\",\n \"notifiable-id\": 230,\n \"schema-template-id\": 7\n },\n \"relationships\": {\n \"created-by\": {\n \"data\": {\n \"id\": \"1\",\n \"type\": \"users\"\n }\n },\n \"project\": {\n \"data\": {\n \"id\": \"2\",\n \"type\": \"projects\"\n }\n },\n \"user\": {\n \"data\": {\n \"id\": \"4\",\n \"type\": \"users\"\n }\n }\n }\n },\n {\n \"id\": \"868\",\n \"type\": \"notifications\",\n \"attributes\": {\n \"client-id\": 1,\n \"created-by-id\": 1,\n \"created-at\": \"2023-05-13T03:22:49.715Z\",\n \"updated-at\": \"2023-05-13T03:22:49.715Z\",\n \"read-at\": null,\n \"text\": \"report_is_ready\",\n \"text-params\": {\n \"report_description\": \"Quidem eos vitae vel ipsum necessitatibus cumque magnam animi. Magnam id modi iusto esse dolorum rerum reprehenderit. Error enim aliquam aspernatur debitis ut.\",\n \"user_name\": \"Catherina Hegmann\",\n \"id\": 278\n },\n \"notifiable-type\": \"Report\",\n \"notifiable-id\": 278,\n \"schema-template-id\": 13\n },\n \"relationships\": {\n \"created-by\": {\n \"data\": {\n \"id\": \"1\",\n \"type\": \"users\"\n }\n },\n \"project\": {\n \"data\": {\n \"id\": \"2\",\n \"type\": \"projects\"\n }\n },\n \"user\": {\n \"data\": {\n \"id\": \"4\",\n \"type\": \"users\"\n }\n }\n }\n },\n {\n \"id\": \"863\",\n \"type\": \"notifications\",\n \"attributes\": {\n \"client-id\": 1,\n \"created-by-id\": 1,\n \"created-at\": \"2023-05-13T03:22:49.630Z\",\n \"updated-at\": \"2023-05-13T03:22:49.630Z\",\n \"read-at\": null,\n \"text\": \"report_is_ready\",\n \"text-params\": {\n \"report_description\": \"Quia magni ea assumenda voluptates rem. Iure id quibusdam eaque natus nam. Fugiat voluptate quasi dolorum earum ex aperiam.\",\n \"user_name\": \"Catherina Hegmann\",\n \"id\": 256\n },\n \"notifiable-type\": \"Report\",\n \"notifiable-id\": 256,\n \"schema-template-id\": 11\n },\n \"relationships\": {\n \"created-by\": {\n \"data\": {\n \"id\": \"1\",\n \"type\": \"users\"\n }\n },\n \"project\": {\n \"data\": {\n \"id\": \"2\",\n \"type\": \"projects\"\n }\n },\n \"user\": {\n \"data\": {\n \"id\": \"4\",\n \"type\": \"users\"\n }\n }\n }\n },\n {\n \"id\": \"860\",\n \"type\": \"notifications\",\n \"attributes\": {\n \"client-id\": 1,\n \"created-by-id\": 1,\n \"created-at\": \"2023-05-13T03:22:49.658Z\",\n \"updated-at\": \"2023-05-13T03:22:49.658Z\",\n \"read-at\": null,\n \"text\": \"report_is_ready\",\n \"text-params\": {\n \"report_description\": \"Occaecati alias rem dicta eaque laudantium nesciunt facere ipsa. Aspernatur eos hic minima adipisci. Rem ad ex doloribus ipsam ea iure.\",\n \"user_name\": \"Catherina Hegmann\",\n \"id\": 240\n },\n \"notifiable-type\": \"Report\",\n \"notifiable-id\": 240,\n \"schema-template-id\": 9\n },\n \"relationships\": {\n \"created-by\": {\n \"data\": {\n \"id\": \"1\",\n \"type\": \"users\"\n }\n },\n \"project\": {\n \"data\": {\n \"id\": \"2\",\n \"type\": \"projects\"\n }\n },\n \"user\": {\n \"data\": {\n \"id\": \"4\",\n \"type\": \"users\"\n }\n }\n }\n },\n {\n \"id\": \"854\",\n \"type\": \"notifications\",\n \"attributes\": {\n \"client-id\": 1,\n \"created-by-id\": 1,\n \"created-at\": \"2023-05-13T03:22:49.493Z\",\n \"updated-at\": \"2023-05-13T03:22:49.493Z\",\n \"read-at\": null,\n \"text\": \"report_is_ready\",\n \"text-params\": {\n \"report_description\": \"Libero officia pariatur tenetur vel. Quo nemo mollitia odit consectetur. Accusamus voluptatibus dignissimos nesciunt aperiam nemo. Aliquam nulla laboriosam suscipit possimus corporis. Illum quidem laboriosam non rerum quos voluptate perferendis.\",\n \"user_name\": \"Catherina Hegmann\",\n \"id\": 281\n },\n \"notifiable-type\": \"Report\",\n \"notifiable-id\": 281,\n \"schema-template-id\": 13\n },\n \"relationships\": {\n \"created-by\": {\n \"data\": {\n \"id\": \"1\",\n \"type\": \"users\"\n }\n },\n \"project\": {\n \"data\": {\n \"id\": \"2\",\n \"type\": \"projects\"\n }\n },\n \"user\": {\n \"data\": {\n \"id\": \"4\",\n \"type\": \"users\"\n }\n }\n }\n },\n {\n \"id\": \"853\",\n \"type\": \"notifications\",\n \"attributes\": {\n \"client-id\": 1,\n \"created-by-id\": 1,\n \"created-at\": \"2023-05-13T03:22:49.509Z\",\n \"updated-at\": \"2023-05-13T03:22:49.509Z\",\n \"read-at\": null,\n \"text\": \"report_is_ready\",\n \"text-params\": {\n \"report_description\": \"Sit ut aliquam minus blanditiis. Nisi corrupti perferendis qui ea placeat expedita. Inventore perferendis maiores facilis explicabo dolorem aspernatur suscipit.\",\n \"user_name\": \"Catherina Hegmann\",\n \"id\": 172\n },\n \"notifiable-type\": \"Report\",\n \"notifiable-id\": 172,\n \"schema-template-id\": 1\n },\n \"relationships\": {\n \"created-by\": {\n \"data\": {\n \"id\": \"1\",\n \"type\": \"users\"\n }\n },\n \"project\": {\n \"data\": {\n \"id\": \"2\",\n \"type\": \"projects\"\n }\n },\n \"user\": {\n \"data\": {\n \"id\": \"4\",\n \"type\": \"users\"\n }\n }\n }\n },\n {\n \"id\": \"840\",\n \"type\": \"notifications\",\n \"attributes\": {\n \"client-id\": 1,\n \"created-by-id\": 1,\n \"created-at\": \"2023-05-13T03:22:30.859Z\",\n \"updated-at\": \"2023-05-13T03:22:30.859Z\",\n \"read-at\": null,\n \"text\": \"report_moved_to_your_zone\",\n \"text-params\": {\n \"user_name\": \"Catherina Hegmann\",\n \"id\": 312\n },\n \"notifiable-type\": \"Report\",\n \"notifiable-id\": 312,\n \"schema-template-id\": 13\n },\n \"relationships\": {\n \"created-by\": {\n \"data\": {\n \"id\": \"1\",\n \"type\": \"users\"\n }\n },\n \"project\": {\n \"data\": {\n \"id\": \"2\",\n \"type\": \"projects\"\n }\n },\n \"user\": {\n \"data\": {\n \"id\": \"4\",\n \"type\": \"users\"\n }\n }\n }\n }\n ],\n \"included\": [\n {\n \"id\": \"4\",\n \"type\": \"users\",\n \"attributes\": {\n \"first-name\": \"Catherina\",\n \"last-name\": \"Hegmann\",\n \"position\": \"nisi provident quia\"\n },\n \"relationships\": {}\n }\n ],\n \"meta\": {\n \"total_pages\": 8,\n \"total_count\": 74,\n \"project_counts\": {\n \"1\": 20,\n \"2\": 54\n }\n }\n}"}],"_postman_id":"ec1d489e-8678-4f49-a96a-fc01cf5c32fe"},{"name":"mark_as_read","event":[{"listen":"test","script":{"id":"a4f32d9a-c7a7-4d24-842a-cf3288fa734e","exec":[""],"type":"text/javascript"}}],"id":"369c5eb5-ec74-42bb-b8b5-0983505f78d2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://b.prysmex.com/api/notifications/:id/mark_as_read","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","name":"Authenticated endpoints","type":"folder"}},"urlObject":{"path":["api","notifications",":id","mark_as_read"],"host":["https://b.prysmex.com"],"query":[],"variable":[{"id":"c29a3610-e020-486f-9f62-d443d85ad911","type":"string","value":"{{_notification_id}}","key":"id"}]}},"response":[],"_postman_id":"369c5eb5-ec74-42bb-b8b5-0983505f78d2"},{"name":"mark_as_unread","id":"89467177-13bb-4f78-82ad-72ea35b55bd5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://b.prysmex.com/api/notifications/:id/mark_as_unread","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","name":"Authenticated endpoints","type":"folder"}},"urlObject":{"path":["api","notifications",":id","mark_as_unread"],"host":["https://b.prysmex.com"],"query":[],"variable":[{"id":"2f0c55ea-a0f7-4c3e-849e-6296c2ac10f5","type":"any","value":"{{_notification_id}}","key":"id"}]}},"response":[],"_postman_id":"89467177-13bb-4f78-82ad-72ea35b55bd5"},{"name":"mark_all_as_read","id":"613f1cfd-1547-4e8a-8937-d9cac35ca2da","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://b.prysmex.com/api/notifications/mark_all_as_read","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","name":"Authenticated endpoints","type":"folder"}},"urlObject":{"path":["api","notifications","mark_all_as_read"],"host":["https://b.prysmex.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"613f1cfd-1547-4e8a-8937-d9cac35ca2da"}],"id":"f2a01fbe-a721-4f91-a589-0dfb2d754d8a","_postman_id":"f2a01fbe-a721-4f91-a589-0dfb2d754d8a","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","name":"Authenticated endpoints","type":"folder"}}},{"name":"Email events","item":[{"name":"index","event":[{"listen":"test","script":{"id":"0d48c1e2-e822-4b57-9052-8ada6d7a9d33","exec":[""],"type":"text/javascript","packages":{}}}],"id":"b4554352-d5dc-453c-8e3d-d8ff58e3c82e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://b.prysmex.com/api/email_events","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","name":"Authenticated endpoints","type":"folder"}},"urlObject":{"path":["api","email_events"],"host":["https://b.prysmex.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"b4554352-d5dc-453c-8e3d-d8ff58e3c82e"}],"id":"7bd3ab6f-e6ec-49df-8fab-d28011ddedd6","_postman_id":"7bd3ab6f-e6ec-49df-8fab-d28011ddedd6","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","id":"6f0c2455-ea1f-49d0-b0b7-5e7be52434a3","name":"Authenticated endpoints","type":"folder"}}},{"name":"Support","item":[{"name":"bootstrap","event":[{"listen":"prerequest","script":{"id":"99cd6723-035b-48a2-942f-8fe89d63cd1f","exec":[""],"type":"text/javascript","packages":{},"requests":{}}},{"listen":"test","script":{"id":"57f86e98-cab9-4988-9c8f-dc01f3a3232e","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"a649c6ae-755c-41d5-b413-018c65cb8fd6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://b.prysmex.com/api/bootstrap","description":"

This request is used to initialize Prysmex's Ember application.

Attributes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Value
name *	string
location *	json
is-hazardous	boolean
interior	boolean
natural-ventilation	boolean
moving-machinery	boolean
light-reflection-index	float

Relationships

project *
workers

*Required

Attributes

Data Model

The following tables describe the attributes available for this model, divided into two categories: 📤 API-settable and 🔒 System-managed attributes.

📤 Settable

🔒 System managed

See Common Attributes

🔗 Relationships

","_postman_id":"dad9047f-82ff-4a5a-ba0a-ba57b14aa413","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":"

🎉 Welcome to the Prysmex API Documentation! v8.4.11

Setup

👤 Create a Prysmex account

📁 Create a space

🔑 Generate an API KEY

↓ Import the collection

⚙️ Configure the collection

🚀 Run your first request!

Collection conventions

API conventions

Data format - JSON API {}

Authentication

JSON:API Headers

📥 Accept Header (recommended for read requests)

📤 Content-Type Header (required for write requests)

Try your first requests

Query params in body

📌 Optional Query Parameters

🌍 Locale Resolution

Filtering / pagination

Pagination

Basic filtering

Negating a query

Disabling a query

Filter group

Advanced filtering

Custom serialization

fields hash

include array

links boolean

i18n boolean string array

Example

Security

JSONAPI flat

Errors

Error payload examples

Bulk actions

Create

Update

Destroy

Nested actions

Example: Creating an Inspection with a Report

Example: Updating an Inspection deleting existing Report and adding a new Report

Data models

Doc conventions

Common Data Model attributes

📤 Settable

🔒 System managed

Disclaimers

Attributes

Data Model

📤 Settable

🔒 System managed

🔗 Relationships

Required attributes

Required relationships

Required attributes

Required relationships

Required attributes

Required relationships

Required attributes

Required relationships

Required attributes

Required relationships

Attributes

🌎 Global user data

📤 Settable

🔒 System managed

📁 Space specific user data

📤 Settable

🔒 System managed

🔗 Relationships

Additional filtering attributes

Attributes

Data Model

📤 Settable

🔒 System managed

🔗 Relationships

Attributes

📤 Settable

🎉 Welcome to the Prysmex API Documentation! `v8.4.11`

📥 `Accept` Header (recommended for read requests)

📤 `Content-Type` Header (required for write requests)

fields `hash`

include `array`

links `boolean`

i18n `boolean` `string` `array`