Selfhosted API not working ;(
Hey! We have 0.41 selfhosted and we are having a very hard time getting the API to work with our integrations (such as windmill). Authorization over the API is working fine (not able to access the api call documentation and trying it out without provision of proper API key), however, every tested API Call returns 500 internal server error. Not connected to basic functionality (show companies) or customized (show custom objects)
38 Replies
hey, can you share the query you made and the error?
according to API Documentation /developers/rest-api/core
depth
:
Not Set12
select an option (defaults to: 1)
ending_before
:
string
filter
:
example: createdAt[gte]:"2023-01-01"
Pick an examplesimplesimpleNestedcomplex
select an option
limit
:
defaults to: 60
order_by
:
example: createdAt
Pick an examplesimplecomplex
select an option
starting_after
:
string
Result:
500 Internal Server Error
No supported response body returned
I don't get it. You said you are self hosting. So you must have your own twenty app running on your own url?
I am using this URL to validate the API Calls: https://twenty.com/developers/rest-api/core#/operations/findManyViewFields
Twenty.com
Open Source CRM
yes, still using the api doc you are hosting to validate the API calls while switching to other environment and putting in the address of our own self hosted environment
so you also have an account in cloud to call?
no, I created in our twnetycrm system an API Key, provided the custom path in the URL that I just posted, put in API key, got success ful authentication . or are you telling me that its not possible to use this kind of API documentation with live testing with self hosted? If that is the case, how can we test against our own API?
I am asking this because we try to connect windmill (selfhosted) with twentyCRM (selfhosted) but we want to ensure that API is working correctly on twentyCRM side and I was under the impression that testing API can be done easily with this swagger like doc
got it. If you set up your url, add your api key and see all expected endpoints it means your setup is good. But then do you see errors in backend logs ?
Yes correct! I could also see custom API calls for the custom objects. Will refer to system admin and produce logs, just a sec,. thanks!
100.82.116.198 - - [12/Feb/2025:16:49:10 +0000] "GET /rest/notes HTTP/1.1" 500 0 "https://twenty.com/" "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/133.0.0.0 Safari/537.36 Edg/133.0.0.0" "-"
Only found this in the http proxy container
We are wondering wether this might be the issue?
and if yes, what should be the values for those variables? 🤔
"Yes, there is an issue with the docker-compose on main, please add both REDIS_HOST and REDIS_URL for now
I think that's it, the REST API is making an http call to the Graphql API for now (we are changing it, likely this month) so you might have faced networking issue
docker compose
ports:
3010:3000 <---- it seems the system uses the internal running port as part of the token generation
I changed to run on 3010 via the env var and the internal port mapping and voila"
@thomast not sure if we configured something wrong on our side
so your request goes as expected to the proxy. Can you share the logs of your server? 500 should come from there. Maybe it's Redis, maybe something else but you should see something in twenty-server logs
thanks, let us check
100.82.116.198 - - [14/Feb/2025:09:08:21 +0000] "GET /rest/apiKeys HTTP/1.1" 500 0 "https://twenty.com/" "Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:134.0) Gecko/20100101 Firefox/134.0" "-"
100.82.116.198 - - [14/Feb/2025:09:08:27 +0000] "GET /rest/auditLogs HTTP/1.1" 500 0 "https://twenty.com/" "Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:134.0) Gecko/20100101 Firefox/134.0" "-"
100.82.116.198 - - [14/Feb/2025:09:08:31 +0000] "GET /rest/attachments HTTP/1.1" 500 0 "https://twenty.com/" "Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:134.0) Gecko/20100101 Firefox/134.0" "-"
100.82.116.198 - - [14/Feb/2025:09:08:42 +0000] "GET /rest/attachments/tst HTTP/1.1" 500 0 "https://twenty.com/" "Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:134.0) Gecko/20100101 Firefox/134.0" "-"
It is not possible for us to find other logs in regards of those API call attempts
Hi @armochillo, could you check your server logs? (docker logs {containerId} if you are using docker
If the requests is hitting your container you'll see it there
you can also try to make the query with curl (I believe it's possible to copy as curl from the REST api docs, not 100% sure) and see if you are having the same result while hitting direclty your server, or your container
Hey, thanks for the suggestion, will refer to devops and come back to you 🙂 thanks!
You are welcome, let us know
We were able to create some logs after firing the curl requests that were copy pasted from the api documentation
@armochillo @charles Not trying to hijack this topic, but if that can help anyone, I am having the same issue. Running 0.41 as well.
I am using n8n with the community-node.
I run n8n in a docker, same for twenty, both are on the same docker network. I get a successful connection using the credential: http://twenty-server-1:3000.
However, for any api call, I always have a error 500.
When I use a temp container and curl using this command:
sudo docker run --rm --network container:n8n curlimages/curl:latest curl -I --request GET \
--url 'http://twenty-server-1:3000/rest/companies/490a5309-8239-4b1f-be34-72e51cfa85ab?depth=1' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer "API KEY"'
I get this error:
HTTP/1.1 500 Internal Server Error
X-Powered-By: Express
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET,HEAD,PUT,PATCH,POST,DELETE
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept
Content-Type: application/json; charset=utf-8
Date: Mon, 17 Feb 2025 16:29:39 GMT
Connection: keep-alive
Keep-Alive: timeout=5
Content-Length: 0
Same when I try from the developer section on twenty.com, I put in my external domain name with my api key, and I am able to see the api call documentation, but I get the same error 500 return on any api calls.
No logs show either way in the server logs.
Is there any feature flags that need to be activated or variable that need to be set in the environment?
No worries, welcome to the party 😄 the more, the merrier
That means you use raw catalog or your catalog doesn't have a translation for the message and fallback was used. ICU features such as interpolation and plurals will not work properly for that message. Please compile your catalog first. Uncompiled message detected! Message: 0exG4Q That means you use raw catalog or your catalog doesn't have a translation for the message and fallback was used. ICU features such as interpolation and plurals will not work properly for that message. Please compile your catalog first. Uncompiled message detected! Message: DXPGs/ That means you use raw catalog or your catalog doesn't have a translation for the message and fallback was used. ICU features such as interpolation and plurals will not work properly for that message. Please compile your catalog first.Unless I'm mistaken theses logs are lingui translations errors, they should not be blocking but are making noise in twenty-server logs right now Not sure but running below commands should fix these logs and makes some spaces in traces
so esentially @David and myself are receiving 500 error for almost all API Calls (did you try to submit the get Api Scheme Call? This worked for me, 200 returned)
and it is not possible to retrieve anything in the logs, feels like we are stuck 😦
Hi @armochillo, would you be availalble for a call later this week?
sure, would like to send you a calendar book link via pm
We installed the 0.43.1 tag on twentyCRM selfhosted and now the docker logs of server-1 show this.
When I try to call e.g. "Find Company duplicates"
I get:
Exception Captured
{ user: undefined, workspace: undefined }
[
TypeError: Cannot read properties of undefined (reading 'data')
at RestApiService.call (/app/packages/twenty-server/dist/src/engine/api/rest/rest-api.service.js:51:71)
at process.processTicksAndRejections (node:internal/process/task_queues:95:5)
at async RestApiCoreService.findDuplicates (/app/packages/twenty-server/dist/src/engine/api/rest/core/rest-api-core.service.js:46:16)
at async RestApiCoreController.handleApiFindDuplicates (/app/packages/twenty-server/dist/src/engine/api/rest/core/controllers/rest-api-core.controller.js:35:24)
@charles I believe the execption catching is working as intendend! 👍
{
"statusCode": 400,
"error": "TypeError",
"messages": [
"Cannot read properties of undefined (reading 'data')"
]
}
Getting 400 now instead of 500, interestingly
@armochillo that's strange
Log into your container to the rest-api.service.js (see path in your error message), edit the file to add a "console.log(url)"
then try again on the rest API (no need to restart your container)
where to add exactly, anywhere, e.g. at top? 😄
right below url definition
url =
baseUrl...thanks! We changed it, now we get this out of logfiles:
Exception Captured
{ user: undefined, workspace: undefined }
[
TypeError: Cannot read properties of undefined (reading 'data')
at RestApiService.call (/app/packages/twenty-server/dist/src/engine/api/rest/rest-api.service.js:51:71)
at process.processTicksAndRejections (node:internal/process/task_queues:95:5)
at async RestApiCoreService.get (/app/packages/twenty-server/dist/src/engine/api/rest/core/rest-api-core.service.js:26:16)
at async RestApiCoreController.handleApiGet (/app/packages/twenty-server/dist/src/engine/api/rest/core/controllers/rest-api-core.controller.js:39:24)
]
Exception Captured
{ user: undefined, workspace: undefined }
[
TypeError: Cannot read properties of undefined (reading 'data')
at RestApiService.call (/app/packages/twenty-server/dist/src/engine/api/rest/rest-api.service.js:51:71)
at process.processTicksAndRejections (node:internal/process/task_queues:95:5)
at async RestApiCoreService.get (/app/packages/twenty-server/dist/src/engine/api/rest/core/rest-api-core.service.js:26:16)
at async RestApiCoreController.handleApiGet (/app/packages/twenty-server/dist/src/engine/api/rest/core/controllers/rest-api-core.controller.js:39:24)
]
You want me to trigger a certain API Function for further testing?
@charles
this is how we changed the file
Hello Guys, I put that aside the last 2 weeks, but I got back into today and spend quite some time today on it.
I am far from being a professional coder. However, I did find some issue and did fix some code and enable logging to find the problem.
By the way, I have also updated to 0.43.
The biggest issue, is the if you make any api request, with the REST api, the url is automatically rewrite to graphql.
so I (taking all the credit for chatgpt here) modify the rest-api.service.js file on the server.
The modification touch the async call:
let RestApiService = class RestApiService {
async call(apiType, request, data) {
let baseUrl;
// Debugging: Log the base URL
console.log('Base URL:', baseUrl);
// Ensure request.path is defined
if (!request.path) {
console.error('Request Path is undefined');
throw new Error('Request Path is required');
}
// Determine the URL based on the API type
let url;
if (apiType === "rest") {
url =
${baseUrl.replace(/\/+$/, '')}/${request.path.replace(/^\/+/, '')};
} else if (apiType === "core") {
url = ${baseUrl}/graphql;
} else if (apiType === "metadata") {
url = ${baseUrl}/metadata;
} else {
throw new Error(Unknown API type: ${apiType});
}
// Debugging: Log the constructed URL
console.log('API URL:', url);
let response;
try {
// Make the HTTP request
response = await this.httpService.axiosRef.post(url, data, {
headers: {
'Content-Type': 'application/json',
Authorization: request.headers.authorization
}
});
} catch (err) {
// Log the error response
console.error('Error Response:', err.response?.data err.message);
throw new _RestApiException.RestApiException(err.response?.data?.errors ['Unknown error']);
}
// Validate the response
if (!response || !response.data) {
console.error('Invalid Response:', response);
throw new _RestApiException.RestApiException(['Invalid response from server']);
}
if (response.data.errors?.length) {
console.error('Response Errors:', response.data.errors);
throw new _RestApiException.RestApiException(response.data.errors);
}
return response;
}
That allow me to see in the log the api url and where they are going.
After this was fix, it took me to the error: Field metadata for field "query" is missing in object metadata
and this is where I am stuck, as I think something is not pass right to the "format-data.util.js" and I don't want to brake anything else LOL
i should add, the error log on the server:Exception Captured
{ user: undefined, workspace: undefined }
[
Error: Field metadata for field "query" is missing in object metadata
at formatData (/app/packages/twenty-server/dist/src/engine/twenty-orm/utils/format-data.util.js:25:19)
at WorkspaceRepository.formatData (/app/packages/twenty-server/dist/src/engine/twenty-orm/repository/workspace.repository.js:283:47)
at process.processTicksAndRejections (node:internal/process/task_queues:95:5)
at async WorkspaceRepository.save (/app/packages/twenty-server/dist/src/engine/twenty-orm/repository/workspace.repository.js:85:43)
at async RestApiCoreServiceV2.createOne (/app/packages/twenty-server/dist/src/engine/api/rest/core/rest-api-core-v2.service.js:45:31)
at async RestApiCoreController.handleApiPost (/app/packages/twenty-server/dist/src/engine/api/rest/core/controllers/rest-api-core.controller.js:47:24)
]
Error Response: {
statusCode: 400,
error: 'Error',
messages: [ 'Field metadata for field "query" is missing in object metadata' ]
}
Exception Captured
{ user: undefined, workspace: undefined }
[
TypeError: Cannot read properties of undefined (reading 'replace')
at formatMessage (/app/packages/twenty-server/dist/src/engine/api/rest/errors/RestApiException.js:14:41)
at /app/packages/twenty-server/dist/src/engine/api/rest/errors/RestApiException.js:26:43
at Array.map (<anonymous>)
at new RestApiException (/app/packages/twenty-server/dist/src/engine/api/rest/errors/RestApiException.js:26:30)
at RestApiService.call (/app/packages/twenty-server/dist/src/engine/api/rest/rest-api.service.js:85:19)
at process.processTicksAndRejections (node:internal/process/task_queues:95:5)
at async RestApiCoreService.get (/app/packages/twenty-server/dist/src/engine/api/rest/core/rest-api-core.service.js:26:16)
at async RestApiCoreController.handleApiGet (/app/packages/twenty-server/dist/src/engine/api/rest/core/controllers/rest-api-core.controller.js:39:24)
]We have fixed the issue ourselves most likely by ignoring the REST Api and simply use the GraphiQL API. Need to confirm further, but seems like Rest API is just not worth looking into at this point because at current understanding, GraphiQL API can do the same and more?
Came here with similar problem ;
The Rest API call where malfunctioning because I switched the host port to 3001 while the container/node port remain 3000.
this configuration fixed the API :
Hello @armochillo, the REST API is GraphQl wrapper overall, it's getting refactored lately not sure on the status of the refactor right now.
What problem have you fixed exactly ?
The frontend mainly, if it's not only, consumes the graphql API. We're created an REST one over the GRAPHQL one in order for easier access from script and serverless function etc
hello @prastoin I did not fix the problem with API, but I Fixed the issue that we were not able to interface with the CRM system; However now we are able to use the GraphiQL API to make the integration, so the REST API not working is not an issue anymore.
Are we correct to assume that we can do the implementation of our techstack with the CRM (e.g. tally forms being used to create new contacts) over the GraphiQL API or is it something that you would advise against?
so the REST API not working is not an issue anymore.Sorry I don't have the whole history, please what was not working exactly Unless I'm mistaken the REST API should be fully functional
Are we correct to assume that we can do the implementation of our techstack with the CRM (e.g. tally forms being used to create new contacts) over the GraphiQL API or is it something that you would advise against?Yes you are, I mean we're building twenty's front on it so that's already "proven". Graphql is just not as much common as REST API are in the ecosystem explaining why we wanted to expose an REST too
This was previous context @Prastoin and thanks for giving additional information on API 🙂
Just out of curiosity @prastoin , how do you switch between the core and metadata API? I am able to reach the graphQL API in selfhosted, but all queries and manipulations towards companies are failing, getting schema introspection returns metadata content. The api is under /grapql but i do not understand how to dedicatetly communicate with core API.
I am using n8n and GraphQL Node to interact with the API. When using python locally to execute a script that submits a query to receive the introspection of schema, I am able to receive all relevant information, companies and custom objects.
But when interacting with graphQL Api over n8n it seems I keep hitting the metadata API and no Idea where to change it 🤷♂️
Hey there, please find our APIs docs here
From my understanding your n8n might wrap its service to only one baseUrl and not the other one
Twenty - Docs
Twenty is a CRM designed to fit your unique business needs.
It seems to be related to @armochillo Twenty's integration that we're discussing by private message atm. Will add a conclusion message to this thread when issue has been fixed