Skip to main content
POST
/
api
/
auth
/
signin
Sign in a user
curl --request POST \
  --url https://api.example.com/api/auth/signin \
  --header 'Content-Type: application/json' \
  --data '
{
  "password": "password123",
  "email": "[email protected]"
}
'
{
  "accessToken": "<string>",
  "organizationId": "<string>",
  "tenantId": 123,
  "userId": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.bigcapital.app/llms.txt

Use this file to discover all available pages before exploring further.

Body

application/json
​
password
string
required

User password

Example:

"password123"

​
email
string
required

User email address

Example:

"[email protected]"

Response

200 - application/json

Sign-in successful. Returns access token and tenant/organization IDs.

​
accessToken
string
required

JWT access token

​
organizationId
string
required

Organization ID

​
tenantId
number
required

Tenant ID

​
userId
number
required

User ID