Skip to content
ReplycoReplycoAPI

Users

A user is a person on your team who signs in to Replyco: an agent or an administrator. Your integration signs in as one of them (see Authentication) and then works under that user’s settings: which tickets the user can see, and what happens when the user resolves a ticket. The other users are the agents you assign tickets to.

Fields that matter

Section titled “Fields that matter”

GET /openapi/user/me returns the user your access token was issued for.

Field Meaning
id, fullName, email Who the user is. fullName is the first and last name.
companyId The company whose data the integration works with.
ticketListPermission The ticket-list tabs the user may open, as a sum of flags: 1 my tickets, 2 not resolved, 4 unassigned, 8 resolved, 16 all tickets, 32 blocked, 64 archive, 128 all for search, 256 snoozed, 512 delayed, 1024 starred. Asking the ticket list for another tab is refused.
showUnlabelledTickets Whether tickets in no folder appear in the user’s ticket list.
unassignThreadUponResolve When true, resolving a ticket also removes its agent.
markAsReadThreadUponResolve When true, resolving a ticket also marks it read.

The user’s access to integrations and folders limits the ticket list too: a ticket of an integration or folder the user cannot see is not listed. To work with every ticket, sign in as a user who can see all integrations and folders.

Terminal window
curl "https://open-api.replyco.com/openapi/user/me" \
  -H "Authorization: Bearer $ACCESS_TOKEN"
{
  "id": "0b2d4f6b-8c0e-4a2c-9e4a-6c8e0a2c4e6a",
  "firstName": "Alex",
  "lastName": "Morgan",
  "fullName": "Alex Morgan",
  "email": "alex.morgan@example.com",
  "companyId": "5e7a9c1e-3f5b-4d7f-8b9d-1f3b5d7f9b1d",
  "unassignThreadUponResolve": false,
  "markAsReadThreadUponResolve": true,
  "showUnlabelledTickets": true
}

Listing and filtering

Section titled “Listing and filtering”

Two operations list your company’s users.

GET /openapi/user/id_name returns every user of your company as one object that maps each user’s id to their full name. Use it to show a list of agents or to find the userId for POST /openapi/thread/assignuser.

POST /openapi/user/simple_paged returns one page of users with id, firstName, lastName, email, lastLogin and companyId. It takes query parameters and no body. The users are in queryable, and the page details in rowCount (users in total), pageCount, pageSize and currentPage.

Parameter What it does Default Limits
page The page to return. 1 Stop at pageCount.
count Users per page. 10 Keep it at 100 or below.
term Keeps the users whose first name, last name or email contains the text, ignoring case. none —
sort email. by id —
asc true for ascending, false for descending. true —
Terminal window
curl -X POST "https://open-api.replyco.com/openapi/user/simple_paged?term=morgan&sort=email" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Operations

Section titled “Operations”
Method Path Summary Scopes
GET /openapi/user/id_name Get user ID and name pairs for the current company —
GET /openapi/user/me Get my user details —
POST /openapi/user/simple_paged Get paginated list of simple user information for the current company —

Errors

Section titled “Errors”
Status Meaning Returned by
400 Invalid pagination parameters (e.g., page size exceeds 100) POST /openapi/user/simple_paged
401 User is not authenticated or authorized; User is not authenticated or authorized. GET /openapi/user/id_name, GET /openapi/user/me, POST /openapi/user/simple_paged
403 User does not have permission to view company users GET /openapi/user/id_name, POST /openapi/user/simple_paged
Section titled “Related”