The User object

Attributes

id string

Unique identifier for the object.

created_at string

ISO 8601 timestamp of when the object was created.

updated_at string

ISO 8601 timestamp of when the object was last updated.

email string required
first_name string required
middle_name string
last_name string
full_name string
username string
enabled boolean

Default: true

user_type string

Default: System User

language string
time_zone string
user_image string
gender string
phone string
mobile_no string
birth_date string
last_login string
last_active string
api_key string
api_secret string
signature_image string
The User object 
{
  "id": "user_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "email": "[email protected]",
  "first_name": "first_name_example",
  "middle_name": "middle_name_example",
  "last_name": "last_name_example",
  "full_name": "full_name_example",
  "username": "username_example",
  "enabled": true,
  "user_type": "System User",
  "language": "language_example",
  "time_zone": "time_zone_example",
  "user_image": "user_image_example",
  "gender": "gender_example",
  "phone": "phone_example",
  "mobile_no": "mobile_no_example",
  "birth_date": "2024-01-15",
  "last_login": "last_login_example",
  "last_active": "last_active_example",
  "api_key": "api_key_example",
  "api_secret": "api_secret_example",
  "signature_image": "signature_image_example"
}
GET /api/core/user/{id}

Retrieve a user

Retrieves the details of an existing user. Supply the unique user ID that was returned from a previous request.

Path parameters

id string required

The identifier of the user to retrieve.

Returns

Returns the user object if a valid identifier was provided.

GET /api/core/user/{id} 
curl https://api.overplane.dev/api/core/user/user_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "user_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "email": "[email protected]",
  "first_name": "first_name_example",
  "middle_name": "middle_name_example",
  "last_name": "last_name_example",
  "full_name": "full_name_example",
  "username": "username_example",
  "enabled": true,
  "user_type": "System User",
  "language": "language_example",
  "time_zone": "time_zone_example",
  "user_image": "user_image_example",
  "gender": "gender_example",
  "phone": "phone_example",
  "mobile_no": "mobile_no_example",
  "birth_date": "2024-01-15",
  "last_login": "last_login_example",
  "last_active": "last_active_example",
  "api_key": "api_key_example",
  "api_secret": "api_secret_example",
  "signature_image": "signature_image_example"
}
GET /api/core/user

List all users

Returns a list of users. The results are sorted by creation date, with the most recently created appearing first.

Query parameters

limit integer

Maximum number of objects to return. Default: 20.

offset integer

Number of objects to skip for pagination. Default: 0.

Returns

A paginated list of user objects.

GET /api/core/user 
curl https://api.overplane.dev/api/core/user \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "user_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "email": "[email protected]",
      "first_name": "first_name_example",
      "middle_name": "middle_name_example",
      "last_name": "last_name_example",
      "full_name": "full_name_example",
      "username": "username_example",
      "enabled": true,
      "user_type": "System User",
      "language": "language_example",
      "time_zone": "time_zone_example",
      "user_image": "user_image_example",
      "gender": "gender_example",
      "phone": "phone_example",
      "mobile_no": "mobile_no_example",
      "birth_date": "2024-01-15",
      "last_login": "last_login_example",
      "last_active": "last_active_example",
      "api_key": "api_key_example",
      "api_secret": "api_secret_example",
      "signature_image": "signature_image_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/core/user

Create a user

Creates a new user object.

Body parameters

email string required
first_name string required
middle_name string
last_name string
full_name string
username string
enabled boolean

Default: true

user_type string

Default: System User

language string
time_zone string
user_image string
gender string
phone string
mobile_no string
birth_date string
last_login string
last_active string
api_key string
api_secret string
signature_image string

Returns

Returns the newly created user object if the call succeeded.

POST /api/core/user 
curl https://api.overplane.dev/api/core/user \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"email":"[email protected]","first_name":"first_name_example"}'
Response 
{
  "id": "user_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "email": "[email protected]",
  "first_name": "first_name_example",
  "middle_name": "middle_name_example",
  "last_name": "last_name_example",
  "full_name": "full_name_example",
  "username": "username_example",
  "enabled": true,
  "user_type": "System User",
  "language": "language_example",
  "time_zone": "time_zone_example",
  "user_image": "user_image_example",
  "gender": "gender_example",
  "phone": "phone_example",
  "mobile_no": "mobile_no_example",
  "birth_date": "2024-01-15",
  "last_login": "last_login_example",
  "last_active": "last_active_example",
  "api_key": "api_key_example",
  "api_secret": "api_secret_example",
  "signature_image": "signature_image_example"
}
PATCH /api/core/user/{id}

Update a user

Updates the specified user by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Path parameters

id string required

The identifier of the user to update.

Body parameters

email string
first_name string
middle_name string
last_name string
full_name string
username string
enabled boolean

Default: true

user_type string

Default: System User

language string
time_zone string
user_image string
gender string
phone string
mobile_no string
birth_date string
last_login string
last_active string
api_key string
api_secret string
signature_image string

Returns

Returns the updated user object.

PATCH /api/core/user/{id} 
curl https://api.overplane.dev/api/core/user/user_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"email":"[email protected]","first_name":"first_name_example"}'
Response 
{
  "id": "user_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "email": "[email protected]",
  "first_name": "first_name_example",
  "middle_name": "middle_name_example",
  "last_name": "last_name_example",
  "full_name": "full_name_example",
  "username": "username_example",
  "enabled": true,
  "user_type": "System User",
  "language": "language_example",
  "time_zone": "time_zone_example",
  "user_image": "user_image_example",
  "gender": "gender_example",
  "phone": "phone_example",
  "mobile_no": "mobile_no_example",
  "birth_date": "2024-01-15",
  "last_login": "last_login_example",
  "last_active": "last_active_example",
  "api_key": "api_key_example",
  "api_secret": "api_secret_example",
  "signature_image": "signature_image_example"
}
DELETE /api/core/user/{id}

Delete a user

Permanently deletes a user. This cannot be undone.

Path parameters

id string required

The identifier of the user to delete.

Returns

Returns a confirmation that the user has been deleted.

DELETE /api/core/user/{id} 
curl https://api.overplane.dev/api/core/user/user_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "user_abc123",
  "deleted": true
}